From 83a79ec381960cce860ba9495db43658114eb774 Mon Sep 17 00:00:00 2001
From: Young <afe.young@gmail.com>
Date: Wed, 1 Jun 2016 08:38:39 +0800
Subject: [PATCH] update document for lws_get_context
---
lib/libwebsockets.c | 10 ++++++++++
libwebsockets-api-doc.html | 16 ++++++++++++++++
2 files changed, 26 insertions(+)
diff --git a/lib/libwebsockets.c b/lib/libwebsockets.c
index fa5e61e8..fff2bc36 100644
--- a/lib/libwebsockets.c
+++ b/lib/libwebsockets.c
@@ -1309,6 +1309,16 @@ lws_get_fops(struct lws_context *context)
return &context->fops;
}
+/**
+ * lws_get_context - Allow geting lws_context from a Websocket connection
+ * instance
+ *
+ * With this function, users can access context in the callback function.
+ * Otherwise users may have to declare context as a global variable.
+ *
+ * @wsi: Websocket connection instance
+ */
+
LWS_VISIBLE LWS_EXTERN struct lws_context *
lws_get_context(const struct lws *wsi)
{
diff --git a/libwebsockets-api-doc.html b/libwebsockets-api-doc.html
index 80ccd376..ee113712 100644
--- a/libwebsockets-api-doc.html
+++ b/libwebsockets-api-doc.html
@@ -545,6 +545,22 @@ This is never set at the start of a writeable callback, but any write
may set it.
</blockquote>
<hr>
+<h2>lws_get_context - Allow geting lws_context from a Websocket connection instance</h2>
+<i>LWS_EXTERN struct lws_context *</i>
+<b>lws_get_context</b>
+(<i>const struct lws *</i> <b>wsi</b>)
+<h3>Arguments</h3>
+<dl>
+<dt><b>wsi</b>
+<dd>Websocket connection instance
+</dl>
+<h3>Description</h3>
+<blockquote>
+<p>
+With this function, users can access context in the callback function.
+Otherwise users may have to declare context as a global variable.
+</blockquote>
+<hr>
<h2>lws_parse_uri - </h2>
<i>LWS_EXTERN int</i>
<b>lws_parse_uri</b>
--
GitLab