2016-06-20 17:05:31 +08:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2017-03-20 19:37:47 +08:00
< meta name = "generator" content = "Doxygen 1.8.13" / >
2017-02-05 22:46:39 +08:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2016-06-20 17:05:31 +08:00
< title > libwebsockets: HTTP< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "libwebsockets.org-logo.png" / > < / td >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > libwebsockets
< / div >
< div id = "projectbrief" > Lightweight C library for HTML5 websockets< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2017-03-20 19:37:47 +08:00
<!-- Generated by Doxygen 1.8.13 -->
2017-02-05 22:46:39 +08:00
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
$(function() {
initMenu('',false,false,'search.php','Search');
});
< / script >
< div id = "main-nav" > < / div >
2016-06-20 17:05:31 +08:00
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
$(document).ready(function(){initNavTree('group__http.html','');});
< / script >
< div id = "doc-content" >
< div class = "header" >
< div class = "summary" >
< a href = "#groups" > Modules< / a > |
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > HTTP< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "groups" > < / a >
Modules< / h2 > < / td > < / tr >
< tr class = "memitem:group__form-parsing" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__form-parsing.html" > Form Parsing< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__html-chunked-substitution" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__html-chunked-substitution.html" > HTML Chunked Substitution< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__httpft" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__httpft.html" > HTTP File transfer< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__HTTP-headers-create" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__HTTP-headers-create.html" > HTTP headers: create< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__HTTP-headers-read" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__HTTP-headers-read.html" > HTTP headers: read< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:group__urlendec" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__urlendec.html" > Urlencode and Urldecode< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
Data Structures< / h2 > < / td > < / tr >
< tr class = "memitem:" > < td class = "memItemLeft" align = "right" valign = "top" > struct   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structlws__tokens.html" > lws_tokens< / a > < / td > < / tr >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:gac8a4a71240857dc6b2ed70456b6923f4" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN int  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__http.html#gac8a4a71240857dc6b2ed70456b6923f4" > lws_return_http_status< / a > (struct lws *wsi, unsigned int code, const char *html_body)< / td > < / tr >
< tr class = "separator:gac8a4a71240857dc6b2ed70456b6923f4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga8fbf01e473ac421fc33ad9f8da8b8a25" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__http.html#ga8fbf01e473ac421fc33ad9f8da8b8a25" > lws_http_redirect< / a > (struct lws *wsi, int code, const unsigned char *loc, int len, unsigned char **p, unsigned char *end)< / td > < / tr >
< tr class = "separator:ga8fbf01e473ac421fc33ad9f8da8b8a25" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:gad27aed6c66a41b2b89ffe4da2a309e8a" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__http.html#gad27aed6c66a41b2b89ffe4da2a309e8a" > lws_http_transaction_completed< / a > (struct lws *wsi)< / td > < / tr >
< tr class = "separator:gad27aed6c66a41b2b89ffe4da2a309e8a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< p > Modules related to handling HTTP < / p >
< h2 class = "groupheader" > Function Documentation< / h2 >
2017-02-05 22:46:39 +08:00
< a id = "ga8fbf01e473ac421fc33ad9f8da8b8a25" > < / a >
2017-03-20 19:37:47 +08:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga8fbf01e473ac421fc33ad9f8da8b8a25" > ◆ < / a > < / span > lws_http_redirect()< / h2 >
2017-02-05 22:46:39 +08:00
2016-06-20 17:05:31 +08:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_http_redirect < / td >
< td > (< / td >
< td class = "paramtype" > struct lws *  < / td >
< td class = "paramname" > < em > wsi< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > code< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const unsigned char *  < / td >
< td class = "paramname" > < em > loc< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > len< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned char **  < / td >
< td class = "paramname" > < em > p< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned char *  < / td >
< td class = "paramname" > < em > end< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < code > #include < < a class = "el" href = "libwebsockets_8h.html" > lib/libwebsockets.h< / a > > < / code > < / p >
< p > < a class = "el" href = "group__http.html#ga8fbf01e473ac421fc33ad9f8da8b8a25" > lws_http_redirect()< / a > - write http redirect into buffer< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > wsi< / td > < td > websocket connection < / td > < / tr >
< tr > < td class = "paramname" > code< / td > < td > HTTP response code (eg, 301) < / td > < / tr >
< tr > < td class = "paramname" > loc< / td > < td > where to redirect to < / td > < / tr >
< tr > < td class = "paramname" > len< / td > < td > length of loc < / td > < / tr >
< tr > < td class = "paramname" > p< / td > < td > pointer current position in buffer (updated as we write) < / td > < / tr >
< tr > < td class = "paramname" > end< / td > < td > pointer to end of buffer < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2017-02-05 22:46:39 +08:00
< a id = "gad27aed6c66a41b2b89ffe4da2a309e8a" > < / a >
2017-03-20 19:37:47 +08:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gad27aed6c66a41b2b89ffe4da2a309e8a" > ◆ < / a > < / span > lws_http_transaction_completed()< / h2 >
2017-02-05 22:46:39 +08:00
2016-06-20 17:05:31 +08:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > LWS_VISIBLE LWS_EXTERN int LWS_WARN_UNUSED_RESULT lws_http_transaction_completed < / td >
< td > (< / td >
< td class = "paramtype" > struct lws *  < / td >
< td class = "paramname" > < em > wsi< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < code > #include < < a class = "el" href = "libwebsockets_8h.html" > lib/libwebsockets.h< / a > > < / code > < / p >
< p > < a class = "el" href = "group__http.html#gad27aed6c66a41b2b89ffe4da2a309e8a" > lws_http_transaction_completed()< / a > - wait for new http transaction or close < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > wsi< / td > < td > websocket connection < pre class = "fragment" > Returns 1 if the HTTP connection must close now
Returns 0 and resets connection to wait for new HTTP header /
transaction if possible< / pre > < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2017-02-05 22:46:39 +08:00
< a id = "gac8a4a71240857dc6b2ed70456b6923f4" > < / a >
2017-03-20 19:37:47 +08:00
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gac8a4a71240857dc6b2ed70456b6923f4" > ◆ < / a > < / span > lws_return_http_status()< / h2 >
2017-02-05 22:46:39 +08:00
2016-06-20 17:05:31 +08:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > LWS_VISIBLE LWS_EXTERN int lws_return_http_status < / td >
< td > (< / td >
< td class = "paramtype" > struct lws *  < / td >
< td class = "paramname" > < em > wsi< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned int  < / td >
< td class = "paramname" > < em > code< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *  < / td >
< td class = "paramname" > < em > html_body< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > < code > #include < < a class = "el" href = "libwebsockets_8h.html" > lib/libwebsockets.h< / a > > < / code > < / p >
< p > < a class = "el" href = "group__http.html#gac8a4a71240857dc6b2ed70456b6923f4" > lws_return_http_status()< / a > - Return simple http status < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > wsi< / td > < td > Websocket instance (available from user callback) < / td > < / tr >
< tr > < td class = "paramname" > code< / td > < td > Status index, eg, 404 < / td > < / tr >
< tr > < td class = "paramname" > html_body< / td > < td > User-readable HTML description < 1KB, or NULL < pre class = "fragment" > Helper to report HTTP errors back to the client cleanly and
consistently< / pre > < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "footer" > Generated by
< a href = "http://www.doxygen.org/index.html" >
2017-03-20 19:37:47 +08:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.13 < / li >
2016-06-20 17:05:31 +08:00
< / ul >
< / div >
< / body >
< / html >
