gdax-orderbook-hpp/demo/dependencies/websocketpp-0.7.0/websocketpp/transport/base/endpoint.hpp

   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
  28 #ifndef WEBSOCKETPP_TRANSPORT_BASE_HPP
  29 #define WEBSOCKETPP_TRANSPORT_BASE_HPP
  30
  31 #include <websocketpp/common/functional.hpp>
  32 #include <websocketpp/common/system_error.hpp>
  33
  34 namespace websocketpp {
  35 /// Transport policies provide network connectivity and timers
  36 /**
  37  * ### Endpoint Interface
  38  *
  39  * Transport endpoint components needs to provide:
  40  *
  41  * **init**\n
  42  * `lib::error_code init(transport_con_ptr tcon)`\n
  43  * init is called by an endpoint once for each newly created connection.
  44  * It's purpose is to give the transport policy the chance to perform any
  45  * transport specific initialization that couldn't be done via the default
  46  * constructor.
  47  *
  48  * **is_secure**\n
  49  * `bool is_secure() const`\n
  50  * Test whether the transport component of this endpoint is capable of secure
  51  * connections.
  52  *
  53  * **async_connect**\n
  54  * `void async_connect(transport_con_ptr tcon, uri_ptr location,
  55  *  connect_handler handler)`\n
  56  * Initiate a connection to `location` using the given connection `tcon`. `tcon`
  57  * is a pointer to the transport connection component of the connection. When
  58  * complete, `handler` should be called with the the connection's
  59  * `connection_hdl` and any error that occurred.
  60  *
  61  * **init_logging**
  62  * `void init_logging(alog_type * a, elog_type * e)`\n
  63  * Called once after construction to provide pointers to the endpoint's access
  64  * and error loggers. These may be stored and used to log messages or ignored.
  65  */
  66 namespace transport {
  67
  68 /// The type and signature of the callback passed to the accept method
  69 typedef lib::function<void(lib::error_code const &)> accept_handler;
  70
  71 /// The type and signature of the callback passed to the connect method
  72 typedef lib::function<void(lib::error_code const &)> connect_handler;
  73
  74 } // namespace transport
  75 } // namespace websocketpp
  76
  77 #endif // WEBSOCKETPP_TRANSPORT_BASE_HPP