# ConnectionHandler.hpp
This File On Github
Ask A Question
API: latest
module: oatpp-websocket
#include "oatpp-websocket/ConnectionHandler.hpp"
# ConnectionHandler
Websocket connection handler. Extends oatpp::network::ConnectionHandler.
Will create one thread per each connection to handle communication.
namespace oatpp { namespace websocket {
class ConnectionHandler : public oatpp::base::Countable, public network::ConnectionHandler {}
}}
# Methods
Return Type | Name | Summary |
---|---|---|
[none] | ConnectionHandler | Constructor. |
std::shared_ptr<ConnectionHandler> | createShared | Create shared ConnectionHandler. |
void | setSocketInstanceListener | Set socket instance listener. |
void | handleConnection | Implementation of oatpp::network::ConnectionHandler::handleConnection(). |
void | stop | Implementation of oatpp::network::ConnectionHandler::stop(). |
# ConnectionHandler::ConnectionHandler
Constructor.
ConnectionHandler()
# ConnectionHandler::createShared
Create shared ConnectionHandler.
- @return -
std::shared_ptr
to ConnectionHandler.
static std::shared_ptr<ConnectionHandler> createShared()
# ConnectionHandler::setSocketInstanceListener
Set socket instance listener.
- @param listener - ConnectionHandler::SocketInstanceListener.
void setSocketInstanceListener(const std::shared_ptr<SocketInstanceListener>& listener)
# ConnectionHandler::handleConnection
Implementation of oatpp::network::ConnectionHandler::handleConnection().
- @param connection - oatpp::data::stream::IOStream.
void handleConnection(const provider::ResourceHandle<IOStream>& connection, const std::shared_ptr<const ParameterMap>& params) override
# ConnectionHandler::stop
Implementation of oatpp::network::ConnectionHandler::stop(). Here does nothing.
void stop() override
# ConnectionHandler::SocketInstanceListener
Listener for new websocket instances.
namespace oatpp { namespace websocket {
class ConnectionHandler : public oatpp::base::Countable, public network::ConnectionHandler {
class SocketInstanceListener {}
};
}}
# Typedefs
Type | Name | Summary |
---|---|---|
oatpp::websocket::WebSocket | WebSocket | Convenience typedef fo oatpp::websocket::WebSocket. |
oatpp::network::ConnectionHandler::ParameterMap | ParameterMap | Convenience typedef for oatpp::network::ConnectionHandler::ParameterMap. |
# Methods
Return Type | Name | Summary |
---|---|---|
void | onAfterCreate | Called when socket is created |
void | onBeforeDestroy | Called before socket instance is destroyed. |
# ConnectionHandler::SocketInstanceListener::WebSocket
Convenience typedef fo oatpp::websocket::WebSocket.
typedef oatpp::websocket::WebSocket WebSocket
# ConnectionHandler::SocketInstanceListener::ParameterMap
Convenience typedef for oatpp::network::ConnectionHandler::ParameterMap.
typedef oatpp::network::ConnectionHandler::ParameterMap ParameterMap
# ConnectionHandler::SocketInstanceListener::onAfterCreate
Called when socket is created
- @param socket - oatpp::websocket::WebSocket.
- @param params -
std::shared_ptr
to const oatpp::network::ConnectionHandler::ParameterMap.
virtual void onAfterCreate(const WebSocket& socket, const std::shared_ptr<const ParameterMap>& params) = 0
# ConnectionHandler::SocketInstanceListener::onBeforeDestroy
Called before socket instance is destroyed.
- @param socket - oatpp::websocket::WebSocket.
virtual void onBeforeDestroy(const WebSocket& socket) = 0