adds security policy interface documentation

This commit is contained in:
Peter Thorson
2013-05-04 11:52:13 -05:00
parent 54fdf1af72
commit 6561a9be20

View File

@@ -39,6 +39,25 @@
#include <iostream>
#include <string>
// Interface that sockets/security policies must impliment
/**
* Endpoint Interface
*
* bool is_secure() const;
* @return Wether or not the endpoint creates secure connections
*
* lib::error_code init(socket_con_ptr scon);
* Called by the transport after a new connection is created to initialize
* the socket component of the connection.
* @param scon Pointer to the socket component of the connection
* @return Error code (empty on success)
*/
/// Connection
/// TODO
namespace websocketpp {
namespace transport {
namespace asio {