mirror of
https://github.com/XRPLF/rippled.git
synced 2026-04-29 15:37:57 +00:00
adds transport policy interface documentation
This commit is contained in:
@@ -45,6 +45,23 @@ typedef lib::function<void(connection_hdl,const lib::error_code&)> connect_handl
|
||||
|
||||
typedef lib::function<void()> endpoint_lock;
|
||||
|
||||
// Endpoint interface
|
||||
// Methods a transport endpoint must impliment
|
||||
|
||||
/// Initialize a connection
|
||||
/**
|
||||
* Signature: lib::error_code init(transport_con_ptr tcon);
|
||||
*
|
||||
* 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
|
||||
*/
|
||||
|
||||
} // namespace transport
|
||||
} // namespace websocketpp
|
||||
|
||||
|
||||
Reference in New Issue
Block a user