mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2025-01-20 12:37:13 +01:00
223 lines
8.6 KiB
C++
223 lines
8.6 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_IOSTREAM_HPP
|
|
#define WEBSOCKETPP_TRANSPORT_IOSTREAM_HPP
|
|
|
|
#include <websocketpp/transport/base/endpoint.hpp>
|
|
#include <websocketpp/transport/iostream/connection.hpp>
|
|
|
|
#include <websocketpp/uri.hpp>
|
|
#include <websocketpp/logger/levels.hpp>
|
|
|
|
#include <websocketpp/common/memory.hpp>
|
|
|
|
#include <ostream>
|
|
|
|
namespace websocketpp {
|
|
namespace transport {
|
|
namespace iostream {
|
|
|
|
template <typename config>
|
|
class endpoint {
|
|
public:
|
|
/// Type of this endpoint transport component
|
|
typedef endpoint type;
|
|
/// Type of a pointer to this endpoint transport component
|
|
typedef lib::shared_ptr<type> ptr;
|
|
|
|
/// Type of this endpoint's concurrency policy
|
|
typedef typename config::concurrency_type concurrency_type;
|
|
/// Type of this endpoint's error logging policy
|
|
typedef typename config::elog_type elog_type;
|
|
/// Type of this endpoint's access logging policy
|
|
typedef typename config::alog_type alog_type;
|
|
|
|
/// Type of this endpoint transport component's associated connection
|
|
/// transport component.
|
|
typedef iostream::connection<config> transport_con_type;
|
|
/// Type of a shared pointer to this endpoint transport component's
|
|
/// associated connection transport component
|
|
typedef typename transport_con_type::ptr transport_con_ptr;
|
|
|
|
// generate and manage our own io_service
|
|
explicit endpoint() : m_output_stream(NULL), m_is_secure(false)
|
|
{
|
|
//std::cout << "transport::iostream::endpoint constructor" << std::endl;
|
|
}
|
|
|
|
/// Register a default output stream
|
|
/**
|
|
* The specified output stream will be assigned to future connections as the
|
|
* default output stream.
|
|
*
|
|
* @param o The ostream to use as the default output stream.
|
|
*/
|
|
void register_ostream(std::ostream * o) {
|
|
m_alog->write(log::alevel::devel,"register_ostream");
|
|
m_output_stream = o;
|
|
}
|
|
|
|
/// Set whether or not endpoint can create secure connections
|
|
/**
|
|
* The iostream transport does not provide any security features. As such
|
|
* it defaults to returning false when `is_secure` is called. However, the
|
|
* iostream transport may be used to wrap an external socket API that may
|
|
* provide secure transport. This method allows that external API to flag
|
|
* whether or not it can create secure connections so that users of the
|
|
* WebSocket++ API will get more accurate information.
|
|
*
|
|
* Setting this value only indicates whether or not the endpoint is capable
|
|
* of producing and managing secure connections. Connections produced by
|
|
* this endpoint must also be individually flagged as secure if they are.
|
|
*
|
|
* @since 0.3.0-alpha4
|
|
*
|
|
* @param value Whether or not the endpoint can create secure connections.
|
|
*/
|
|
void set_secure(bool value) {
|
|
m_is_secure = value;
|
|
}
|
|
|
|
/// Tests whether or not the underlying transport is secure
|
|
/**
|
|
* iostream transport will return false by default because it has no
|
|
* information about the ultimate remote endpoint. This may or may not be
|
|
* accurate depending on the real source of bytes being input. `set_secure`
|
|
* may be used by a wrapper API to correct the return value in the case that
|
|
* secure connections are in fact possible.
|
|
*
|
|
* @return Whether or not the underlying transport is secure
|
|
*/
|
|
bool is_secure() const {
|
|
return m_is_secure;
|
|
}
|
|
|
|
/// Sets the write handler
|
|
/**
|
|
* The write handler is called when the iostream transport receives data
|
|
* that needs to be written to the appropriate output location. This handler
|
|
* can be used in place of registering an ostream for output.
|
|
*
|
|
* The signature of the handler is
|
|
* `lib::error_code (connection_hdl, char const *, size_t)` The
|
|
* code returned will be reported and logged by the core library.
|
|
*
|
|
* @since 0.5.0
|
|
*
|
|
* @param h The handler to call on connection shutdown.
|
|
*/
|
|
void set_write_handler(write_handler h) {
|
|
m_write_handler = h;
|
|
}
|
|
|
|
/// Sets the shutdown handler
|
|
/**
|
|
* The shutdown handler is called when the iostream transport receives a
|
|
* notification from the core library that it is finished with all read and
|
|
* write operations and that the underlying transport can be cleaned up.
|
|
*
|
|
* If you are using iostream transport with another socket library, this is
|
|
* a good time to close/shutdown the socket for this connection.
|
|
*
|
|
* The signature of the handler is lib::error_code (connection_hdl). The
|
|
* code returned will be reported and logged by the core library.
|
|
*
|
|
* @since 0.5.0
|
|
*
|
|
* @param h The handler to call on connection shutdown.
|
|
*/
|
|
void set_shutdown_handler(shutdown_handler h) {
|
|
m_shutdown_handler = h;
|
|
}
|
|
protected:
|
|
/// Initialize logging
|
|
/**
|
|
* The loggers are located in the main endpoint class. As such, the
|
|
* transport doesn't have direct access to them. This method is called
|
|
* by the endpoint constructor to allow shared logging from the transport
|
|
* component. These are raw pointers to member variables of the endpoint.
|
|
* In particular, they cannot be used in the transport constructor as they
|
|
* haven't been constructed yet, and cannot be used in the transport
|
|
* destructor as they will have been destroyed by then.
|
|
*
|
|
* @param a A pointer to the access logger to use.
|
|
* @param e A pointer to the error logger to use.
|
|
*/
|
|
void init_logging(lib::shared_ptr<alog_type> a, lib::shared_ptr<elog_type> e) {
|
|
m_elog = e;
|
|
m_alog = a;
|
|
}
|
|
|
|
/// Initiate a new connection
|
|
/**
|
|
* @param tcon A pointer to the transport connection component of the
|
|
* connection to connect.
|
|
* @param u A URI pointer to the URI to connect to.
|
|
* @param cb The function to call back with the results when complete.
|
|
*/
|
|
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb) {
|
|
cb(lib::error_code());
|
|
}
|
|
|
|
/// Initialize a connection
|
|
/**
|
|
* 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.
|
|
*
|
|
* @param tcon A pointer to the transport portion of the connection.
|
|
* @return A status code indicating the success or failure of the operation
|
|
*/
|
|
lib::error_code init(transport_con_ptr tcon) {
|
|
tcon->register_ostream(m_output_stream);
|
|
if (m_shutdown_handler) {
|
|
tcon->set_shutdown_handler(m_shutdown_handler);
|
|
}
|
|
if (m_write_handler) {
|
|
tcon->set_write_handler(m_write_handler);
|
|
}
|
|
return lib::error_code();
|
|
}
|
|
private:
|
|
std::ostream * m_output_stream;
|
|
shutdown_handler m_shutdown_handler;
|
|
write_handler m_write_handler;
|
|
|
|
lib::shared_ptr<elog_type> m_elog;
|
|
lib::shared_ptr<alog_type> m_alog;
|
|
bool m_is_secure;
|
|
};
|
|
|
|
|
|
} // namespace iostream
|
|
} // namespace transport
|
|
} // namespace websocketpp
|
|
|
|
#endif // WEBSOCKETPP_TRANSPORT_IOSTREAM_HPP
|