adds transport policy interface documentation

This commit is contained in:
Peter Thorson
2013-05-04 11:51:55 -05:00
parent 5440ecfcb7
commit 54fdf1af72

View File

@@ -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