update document for lws_get_context
authorYoung <afe.young@gmail.com>
Wed, 1 Jun 2016 00:38:39 +0000 (08:38 +0800)
committerAndy Green <andy@warmcat.com>
Wed, 1 Jun 2016 00:38:39 +0000 (08:38 +0800)
lib/libwebsockets.c
libwebsockets-api-doc.html

index fa5e61e..fff2bc3 100644 (file)
@@ -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)
 {
index 80ccd37..ee11371 100644 (file)
@@ -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>