From 6561a9be2088d0d3e2971d480ebb3baba450ef4c Mon Sep 17 00:00:00 2001
From: Peter Thorson <github@zaphoyd.com>
Date: Sat, 4 May 2013 11:52:13 -0500
Subject: [PATCH] adds security policy interface documentation

---
 websocketpp/transport/asio/security/base.hpp | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/websocketpp/transport/asio/security/base.hpp b/websocketpp/transport/asio/security/base.hpp
index 158d09eadc..bf73db7e51 100644
--- a/websocketpp/transport/asio/security/base.hpp
+++ b/websocketpp/transport/asio/security/base.hpp
@@ -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 {