summaryrefslogtreecommitdiff
path: root/libwebsockets-api-doc.html
diff options
context:
space:
mode:
authorAndy Green <andy@warmcat.com>2011-01-28 10:00:18 +0000
committerAndy Green <andy@warmcat.com>2011-01-28 10:00:18 +0000
commit2ac5a6fce4afaf88b54b54b0337ef1755baab496 (patch)
treed97b79966e608e46a483be6057ac3046edf77ddd /libwebsockets-api-doc.html
parent5b9a4c0d43e78c7b83aa5703ed34291e3456db59 (diff)
fix-host-header-contents--introduce-canonical-hostname-api.patch
I?aki pointed out the dummy host field used in client test and ping is not valid http. This patch changes it to use the actual host name and adds an api to collect that from the context cheaply. Reported-by: I?aki Baz Castillo <ibc@aliax.net> Signed-off-by: Andy Green <andy@warmcat.com>
Diffstat (limited to 'libwebsockets-api-doc.html')
-rw-r--r--libwebsockets-api-doc.html17
1 files changed, 17 insertions, 0 deletions
diff --git a/libwebsockets-api-doc.html b/libwebsockets-api-doc.html
index d070343..f3ee10e 100644
--- a/libwebsockets-api-doc.html
+++ b/libwebsockets-api-doc.html
@@ -112,6 +112,23 @@ If the output side of a server process becomes choked, this allows flow
control for the input side.
</blockquote>
<hr>
+<h2>libwebsocket_canonical_hostname - returns this host's hostname</h2>
+<i>const char *</i>
+<b>libwebsocket_canonical_hostname</b>
+(<i>struct libwebsocket_context *</i> <b>this</b>)
+<h3>Arguments</h3>
+<dl>
+<dt><b>this</b>
+<dd>Websocket context
+</dl>
+<h3>Description</h3>
+<blockquote>
+<p>
+This is typically used by client code to fill in the host parameter
+when making a client connection. You can only call it after the context
+has been created.
+</blockquote>
+<hr>
<h2>libwebsocket_create_context - Create the websocket handler</h2>
<i>struct libwebsocket_context *</i>
<b>libwebsocket_create_context</b>