From daa6b8ff2538659b2bc5e05338600c5aa551dd0d Mon Sep 17 00:00:00 2001 From: Andy Green Date: Sat, 26 Dec 2015 17:36:29 +0800 Subject: [PATCH] update api docs Signed-off-by: Andy Green --- libwebsockets-api-doc.html | 36 ++++++++++++++++++++++++++++-------- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/libwebsockets-api-doc.html b/libwebsockets-api-doc.html index aa666a5..489f831 100644 --- a/libwebsockets-api-doc.html +++ b/libwebsockets-api-doc.html @@ -12,10 +12,8 @@
buf
The data to send. For data being sent on a websocket connection (ie, not default http), this buffer MUST have -LWS_SEND_BUFFER_PRE_PADDING bytes valid BEFORE the pointer -and an additional LWS_SEND_BUFFER_POST_PADDING bytes valid -in the buffer after (buf + len). This is so the protocol -header and trailer data can be added in-situ. +LWS_SEND_BUFFER_PRE_PADDING bytes valid BEFORE the pointer. +This is so the protocol header data can be added in-situ.
len
Count of the data bytes in the payload starting from buf
protocol @@ -945,12 +943,12 @@ is the server's OpenSSL SSL_CTX*

LWS_CALLBACK_OPENSSL_CONTEXT_REQUIRES_PRIVATE_KEY

if configured for -including OpenSSL support but no private key file has been specified -(ssl_private_key_filepath is NULL), this callback is called to +including OpenSSL support but no private key file has been +specified (ssl_private_key_filepath is NULL), this is called to allow the user to set the private key directly via libopenssl and perform further operations if required; this might be useful -in situations where the private key is not directly accessible by -the OS, for example if it is stored on a smartcard +in situations where the private key is not directly accessible +by the OS, for example if it is stored on a smartcard user is the server's OpenSSL SSL_CTX*

LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION

@@ -1107,6 +1105,17 @@ len == 1 allows external threads to be synchronized against wsi lifecycle changes if it acquires the same lock for the duration of wsi dereference from the other thread context. +

LWS_CALLBACK_WS_PEER_INITIATED_CLOSE

+
+The peer has sent an unsolicited Close WS packet. in and +len are the optional close code (first 2 bytes, network +order) and the optional additional information which is not +defined in the standard, and may be a string or non-human- +readble data. +If you return 0 lws will echo the close and then close the +connection. If you return nonzero lws will just close the +connection. +

extension_callback - Hooks to allow extensions to operate

LWS_EXTERN int @@ -1303,6 +1312,8 @@ all sessions, etc, if it wants #else
    void * provided_client_ssl_ctx;
#endif
+    short max_http_header_data;
+    short max_http_header_pool;
};

Members

@@ -1376,5 +1387,14 @@ if this option is selected. implementation for the one provided by provided_ssl_ctx. Libwebsockets no longer is responsible for freeing the context if this option is selected. +
max_http_header_data +
The max amount of header payload that can be handled +in an http request (unrecognized header payload is dropped) +
max_http_header_pool +
The max number of connections with http headers that +can be processed simultaneously (the corresponding memory is +allocated for the lifetime of the context). If the pool is +busy new incoming connections must wait for accept until one +becomes free.
-- 2.7.4