From 54fdf1af727744e5594b80d843bc44394307a954 Mon Sep 17 00:00:00 2001 From: Peter Thorson Date: Sat, 4 May 2013 11:51:55 -0500 Subject: [PATCH] adds transport policy interface documentation --- websocketpp/transport/base/endpoint.hpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/websocketpp/transport/base/endpoint.hpp b/websocketpp/transport/base/endpoint.hpp index b5d0da6657..a4ccec0ac0 100644 --- a/websocketpp/transport/base/endpoint.hpp +++ b/websocketpp/transport/base/endpoint.hpp @@ -45,6 +45,23 @@ typedef lib::function connect_handl typedef lib::function 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