endpoint.hpp 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /*
  2. * Copyright (c) 2014, Peter Thorson. All rights reserved.
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions are met:
  6. * * Redistributions of source code must retain the above copyright
  7. * notice, this list of conditions and the following disclaimer.
  8. * * Redistributions in binary form must reproduce the above copyright
  9. * notice, this list of conditions and the following disclaimer in the
  10. * documentation and/or other materials provided with the distribution.
  11. * * Neither the name of the WebSocket++ Project nor the
  12. * names of its contributors may be used to endorse or promote products
  13. * derived from this software without specific prior written permission.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18. * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
  19. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  21. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  22. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  24. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. *
  26. */
  27. #ifndef WEBSOCKETPP_TRANSPORT_BASE_HPP
  28. #define WEBSOCKETPP_TRANSPORT_BASE_HPP
  29. #include <websocketpp/common/functional.hpp>
  30. #include <websocketpp/common/system_error.hpp>
  31. namespace websocketpp {
  32. /// Transport policies provide network connectivity and timers
  33. /**
  34. * ### Endpoint Interface
  35. *
  36. * Transport endpoint components needs to provide:
  37. *
  38. * **init**\n
  39. * `lib::error_code init(transport_con_ptr tcon)`\n
  40. * init is called by an endpoint once for each newly created connection.
  41. * It's purpose is to give the transport policy the chance to perform any
  42. * transport specific initialization that couldn't be done via the default
  43. * constructor.
  44. *
  45. * **is_secure**\n
  46. * `bool is_secure() const`\n
  47. * Test whether the transport component of this endpoint is capable of secure
  48. * connections.
  49. *
  50. * **async_connect**\n
  51. * `void async_connect(transport_con_ptr tcon, uri_ptr location,
  52. * connect_handler handler)`\n
  53. * Initiate a connection to `location` using the given connection `tcon`. `tcon`
  54. * is a pointer to the transport connection component of the connection. When
  55. * complete, `handler` should be called with the the connection's
  56. * `connection_hdl` and any error that occurred.
  57. *
  58. * **init_logging**
  59. * `void init_logging(const lib::shared_ptr<alog_type>& a, const lib::shared_ptr<elog_type>& e)`\n
  60. * Called once after construction to provide pointers to the endpoint's access
  61. * and error loggers. These may be stored and used to log messages or ignored.
  62. */
  63. namespace transport {
  64. /// The type and signature of the callback passed to the accept method
  65. typedef lib::function<void(lib::error_code const &)> accept_handler;
  66. /// The type and signature of the callback passed to the connect method
  67. typedef lib::function<void(lib::error_code const &)> connect_handler;
  68. } // namespace transport
  69. } // namespace websocketpp
  70. #endif // WEBSOCKETPP_TRANSPORT_BASE_HPP