mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2025-01-20 20:47:15 +01:00
78 lines
3.4 KiB
C++
78 lines
3.4 KiB
C++
/*
|
|
* Copyright (c) 2014, Peter Thorson. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions are met:
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* * Neither the name of the WebSocket++ Project nor the
|
|
* names of its contributors may be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
|
|
#ifndef WEBSOCKETPP_TRANSPORT_BASE_HPP
|
|
#define WEBSOCKETPP_TRANSPORT_BASE_HPP
|
|
|
|
#include <websocketpp/common/functional.hpp>
|
|
#include <websocketpp/common/system_error.hpp>
|
|
|
|
namespace websocketpp {
|
|
/// Transport policies provide network connectivity and timers
|
|
/**
|
|
* ### Endpoint Interface
|
|
*
|
|
* Transport endpoint components needs to provide:
|
|
*
|
|
* **init**\n
|
|
* `lib::error_code init(transport_con_ptr tcon)`\n
|
|
* init is called by an endpoint once for each newly created connection.
|
|
* It's purpose is to give the transport policy the chance to perform any
|
|
* transport specific initialization that couldn't be done via the default
|
|
* constructor.
|
|
*
|
|
* **is_secure**\n
|
|
* `bool is_secure() const`\n
|
|
* Test whether the transport component of this endpoint is capable of secure
|
|
* connections.
|
|
*
|
|
* **async_connect**\n
|
|
* `void async_connect(transport_con_ptr tcon, uri_ptr location,
|
|
* connect_handler handler)`\n
|
|
* Initiate a connection to `location` using the given connection `tcon`. `tcon`
|
|
* is a pointer to the transport connection component of the connection. When
|
|
* complete, `handler` should be called with the the connection's
|
|
* `connection_hdl` and any error that occurred.
|
|
*
|
|
* **init_logging**
|
|
* `void init_logging(const lib::shared_ptr<alog_type>& a, const lib::shared_ptr<elog_type>& e)`\n
|
|
* Called once after construction to provide pointers to the endpoint's access
|
|
* and error loggers. These may be stored and used to log messages or ignored.
|
|
*/
|
|
namespace transport {
|
|
|
|
/// The type and signature of the callback passed to the accept method
|
|
typedef lib::function<void(lib::error_code const &)> accept_handler;
|
|
|
|
/// The type and signature of the callback passed to the connect method
|
|
typedef lib::function<void(lib::error_code const &)> connect_handler;
|
|
|
|
} // namespace transport
|
|
} // namespace websocketpp
|
|
|
|
#endif // WEBSOCKETPP_TRANSPORT_BASE_HPP
|