Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/marian-nmt/Simple-WebSocket-Server.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoreidheim <eidheim@gmail.com>2019-09-17 12:35:05 +0300
committereidheim <eidheim@gmail.com>2019-09-17 12:35:05 +0300
commit64d9c2b2258cefca65c6bf0e17a539868bdb543f (patch)
treeb5fa1e18b479462527e0e578a89a81e30289c8c1 /server_wss.hpp
parenta45a4c5c95788a2f082dbb93dbd0feac37e96c55 (diff)
Added documentation for WSS server and client constructors
Diffstat (limited to 'server_wss.hpp')
-rw-r--r--server_wss.hpp11
1 files changed, 9 insertions, 2 deletions
diff --git a/server_wss.hpp b/server_wss.hpp
index 534e845..d057d1c 100644
--- a/server_wss.hpp
+++ b/server_wss.hpp
@@ -20,9 +20,16 @@ namespace SimpleWeb {
bool set_session_id_context = false;
public:
- SocketServer(const std::string &cert_file, const std::string &private_key_file, const std::string &verify_file = std::string())
+ /**
+ * Constructs a server object.
+ *
+ * @param certification_file If non-empty, sends the given certification file to client.
+ * @param private_key_file Specifies the file containing the private key for certification_file.
+ * @param verify_file If non-empty, use this certificate authority file to perform verification of client's certificate and hostname according to RFC 2818.
+ */
+ SocketServer(const std::string &certification_file, const std::string &private_key_file, const std::string &verify_file = std::string())
: SocketServerBase<WSS>(443), context(asio::ssl::context::tlsv12) {
- context.use_certificate_chain_file(cert_file);
+ context.use_certificate_chain_file(certification_file);
context.use_private_key_file(private_key_file, asio::ssl::context::pem);
if(verify_file.size() > 0) {