test/drogon
1
0
Fork 0
mirror of https://gitee.com/an-tao/drogon.git synced 2024-12-03 12:18:11 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Add some comments to the WebSocketConnection class

Browse Source
This commit is contained in:
antao 2019-06-18 17:00:03 +08:00
parent 386ebfff03
commit a84b559ae9
1 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/inc/drogon/WebSocketConnection.h
View File

@ -36,6 +36,8 @@ class WebSocketConnection
public: public:
WebSocketConnection() = default; WebSocketConnection() = default;
virtual ~WebSocketConnection(){}; virtual ~WebSocketConnection(){};
/// Send a message to the peer
virtual void send( virtual void send(
const char *msg, const char *msg,
uint64_t len, uint64_t len,
@ -44,20 +46,30 @@ class WebSocketConnection
const std::string &msg, const std::string &msg,
const WebSocketMessageType &type = WebSocketMessageType::Text) = 0; const WebSocketMessageType &type = WebSocketMessageType::Text) = 0;
/// Return the local IP address and port number of the connection
virtual const trantor::InetAddress &localAddr() const = 0; virtual const trantor::InetAddress &localAddr() const = 0;
/// Return the remote IP address and port number of the connection
virtual const trantor::InetAddress &peerAddr() const = 0; virtual const trantor::InetAddress &peerAddr() const = 0;
/// Return true if the connection is open
virtual bool connected() const = 0; virtual bool connected() const = 0;
/// Return true if the connection is closed
virtual bool disconnected() const = 0; virtual bool disconnected() const = 0;
virtual void shutdown() = 0; // close write /// Shut down the write direction, which means that further send operations
virtual void forceClose() = 0; // close /// are disabled.
virtual void shutdown() = 0;
/// Close the connection
virtual void forceClose() = 0;
/// Set custom data on the connection
virtual void setContext(const any &context) = 0; virtual void setContext(const any &context) = 0;
/// Get custom data from the connection
virtual const any &getContext() const = 0; virtual const any &getContext() const = 0;
virtual any *getMutableContext() = 0; virtual any *getMutableContext() = 0;
/// Set the heartbeat(ping) message sent to the server. /// Set the heartbeat(ping) message sent to the peer.
/** /**
* NOTE: * NOTE:
* Both the server and the client in Drogon automatically send the pong * Both the server and the client in Drogon automatically send the pong