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" / >
2016-11-14 18:12:31 +08:00
< meta name = "generator" content = "Doxygen 1.8.12" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2016-06-20 17:05:31 +08:00
< title > libwebsockets: Socket adoption helpers< / 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 -->
2016-11-14 18:12:31 +08:00
<!-- Generated by Doxygen 1.8.12 -->
< 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__sock-adopt.html','');});
< / script >
< div id = "doc-content" >
< div class = "header" >
< div class = "summary" >
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Socket adoption helpers< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
< tr class = "memitem:gabe71b7462afb21c767bdc67334f305af" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN struct lws *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af" > lws_adopt_socket< / a > (struct lws_context *context, lws_sockfd_type accept_fd)< / td > < / tr >
< tr class = "separator:gabe71b7462afb21c767bdc67334f305af" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2016-12-22 11:32:34 +08:00
< tr class = "memitem:ga18747e81ff49df2076e7cd4f131f967c" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN struct lws *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__sock-adopt.html#ga18747e81ff49df2076e7cd4f131f967c" > lws_adopt_socket_vhost< / a > (struct lws_vhost *vh, lws_sockfd_type accept_fd)< / td > < / tr >
< tr class = "separator:ga18747e81ff49df2076e7cd4f131f967c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2017-02-22 10:26:42 +08:00
< tr class = "memitem:ga03ec62bedd88f8cef062198a75b2202f" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "ga03ec62bedd88f8cef062198a75b2202f" > < / a >
LWS_VISIBLE struct lws *  < / td > < td class = "memItemRight" valign = "bottom" > < b > lws_adopt_socket_vhost2< / b > (struct lws_vhost *vh, lws_sockfd_type accept_fd, int allow_ssl, int raw)< / td > < / tr >
< tr class = "separator:ga03ec62bedd88f8cef062198a75b2202f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2016-06-20 17:05:31 +08:00
< tr class = "memitem:gab2d045df0f81afe00891aaed312d552b" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN struct lws *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__sock-adopt.html#gab2d045df0f81afe00891aaed312d552b" > lws_adopt_socket_readbuf< / a > (struct lws_context *context, lws_sockfd_type accept_fd, const char *readbuf, size_t len)< / td > < / tr >
< tr class = "separator:gab2d045df0f81afe00891aaed312d552b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2016-12-22 11:32:34 +08:00
< tr class = "memitem:ga5ed5fd251ac0ed46798af341c33bf067" > < td class = "memItemLeft" align = "right" valign = "top" > LWS_VISIBLE LWS_EXTERN struct lws *  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "group__sock-adopt.html#ga5ed5fd251ac0ed46798af341c33bf067" > lws_adopt_socket_vhost_readbuf< / a > (struct lws_vhost *vhost, lws_sockfd_type accept_fd, const char *readbuf, size_t len)< / td > < / tr >
< tr class = "separator:ga5ed5fd251ac0ed46798af341c33bf067" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2016-06-20 17:05:31 +08:00
< / table >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< h2 > Socket adoption helpers< / h2 >
< p > When integrating with an external app with its own event loop, these can be used to accept connections from someone else's listening socket.< / p >
< p > When using lws own event loop, these are not needed. < / p >
< h2 class = "groupheader" > Function Documentation< / h2 >
2016-11-14 18:12:31 +08:00
< a id = "gabe71b7462afb21c767bdc67334f305af" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gabe71b7462afb21c767bdc67334f305af" > § < / a > < / span > lws_adopt_socket()< / h2 >
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 struct lws* lws_adopt_socket < / td >
< td > (< / td >
< td class = "paramtype" > struct lws_context *  < / td >
< td class = "paramname" > < em > context< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > lws_sockfd_type  < / td >
< td class = "paramname" > < em > accept_fd< / 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 >
2016-12-22 11:32:34 +08:00
< p > < a class = "el" href = "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af" > lws_adopt_socket()< / a > - adopt foreign socket as if listen socket accepted it for the default vhost of context. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2016-06-20 17:05:31 +08:00
< table class = "params" >
< tr > < td class = "paramname" > context< / td > < td > lws context < / td > < / tr >
< tr > < td class = "paramname" > accept_fd< / td > < td > fd of already-accepted socket to adopt< / td > < / tr >
< / table >
< / dd >
< / dl >
< p > Either returns new wsi bound to accept_fd, or closes accept_fd and returns NULL, having cleaned up any new wsi pieces.< / p >
< p > LWS adopts the socket in http serving mode, it's ready to accept an upgrade to ws or just serve http. < / p >
< / div >
< / div >
2016-11-14 18:12:31 +08:00
< a id = "gab2d045df0f81afe00891aaed312d552b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gab2d045df0f81afe00891aaed312d552b" > § < / a > < / span > lws_adopt_socket_readbuf()< / h2 >
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 struct lws* lws_adopt_socket_readbuf < / td >
< td > (< / td >
< td class = "paramtype" > struct lws_context *  < / td >
< td class = "paramname" > < em > context< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > lws_sockfd_type  < / td >
< td class = "paramname" > < em > accept_fd< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *  < / td >
< td class = "paramname" > < em > readbuf< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > len< / 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 >
2016-12-22 11:32:34 +08:00
< p > < a class = "el" href = "group__sock-adopt.html#gab2d045df0f81afe00891aaed312d552b" > lws_adopt_socket_readbuf()< / a > - adopt foreign socket and first rx as if listen socket accepted it for the default vhost of context. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
2016-06-20 17:05:31 +08:00
< table class = "params" >
< tr > < td class = "paramname" > context< / td > < td > lws context < / td > < / tr >
< tr > < td class = "paramname" > accept_fd< / td > < td > fd of already-accepted socket to adopt < / td > < / tr >
< tr > < td class = "paramname" > readbuf< / td > < td > NULL or pointer to data that must be drained before reading from accept_fd < / td > < / tr >
< tr > < td class = "paramname" > len< / td > < td > The length of the data held at < / td > < / tr >
< tr > < td class = "paramname" > readbuf< / td > < td > Either returns new wsi bound to accept_fd, or closes accept_fd and returns NULL, having cleaned up any new wsi pieces.< / td > < / tr >
2016-12-22 11:32:34 +08:00
< / table >
< / dd >
< / dl >
< p > LWS adopts the socket in http serving mode, it's ready to accept an upgrade to ws or just serve http.< / p >
< p > If your external code did not already read from the socket, you can use < a class = "el" href = "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af" > lws_adopt_socket()< / a > instead.< / p >
< p > This api is guaranteed to use the data at < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > readbuf< / td > < td > first, before reading from the socket.< / td > < / tr >
< / table >
< / dd >
< / dl >
< p > readbuf is limited to the size of the ah rx buf, currently 2048 bytes. < / p >
< / div >
< / div >
< a id = "ga18747e81ff49df2076e7cd4f131f967c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga18747e81ff49df2076e7cd4f131f967c" > § < / a > < / span > lws_adopt_socket_vhost()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > LWS_VISIBLE LWS_EXTERN struct lws* lws_adopt_socket_vhost < / td >
< td > (< / td >
< td class = "paramtype" > struct lws_vhost *  < / td >
< td class = "paramname" > < em > vh< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > lws_sockfd_type  < / td >
< td class = "paramname" > < em > accept_fd< / 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__sock-adopt.html#ga18747e81ff49df2076e7cd4f131f967c" > lws_adopt_socket_vhost()< / a > - adopt foreign socket as if listen socket accepted it for vhost < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > vhost< / td > < td > lws vhost < / td > < / tr >
< tr > < td class = "paramname" > accept_fd< / td > < td > fd of already-accepted socket to adopt< / td > < / tr >
< / table >
< / dd >
< / dl >
< p > Either returns new wsi bound to accept_fd, or closes accept_fd and returns NULL, having cleaned up any new wsi pieces.< / p >
< p > LWS adopts the socket in http serving mode, it's ready to accept an upgrade to ws or just serve http. < / p >
< / div >
< / div >
< a id = "ga5ed5fd251ac0ed46798af341c33bf067" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga5ed5fd251ac0ed46798af341c33bf067" > § < / a > < / span > lws_adopt_socket_vhost_readbuf()< / h2 >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > LWS_VISIBLE LWS_EXTERN struct lws* lws_adopt_socket_vhost_readbuf < / td >
< td > (< / td >
< td class = "paramtype" > struct lws_vhost *  < / td >
< td class = "paramname" > < em > vhost< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > lws_sockfd_type  < / td >
< td class = "paramname" > < em > accept_fd< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > const char *  < / td >
< td class = "paramname" > < em > readbuf< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > len< / 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__sock-adopt.html#ga5ed5fd251ac0ed46798af341c33bf067" > lws_adopt_socket_vhost_readbuf()< / a > - adopt foreign socket and first rx as if listen socket accepted it for vhost. < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > vhost< / td > < td > lws vhost < / td > < / tr >
< tr > < td class = "paramname" > accept_fd< / td > < td > fd of already-accepted socket to adopt < / td > < / tr >
< tr > < td class = "paramname" > readbuf< / td > < td > NULL or pointer to data that must be drained before reading from accept_fd < / td > < / tr >
< tr > < td class = "paramname" > len< / td > < td > The length of the data held at < / td > < / tr >
< tr > < td class = "paramname" > readbuf< / td > < td > Either returns new wsi bound to accept_fd, or closes accept_fd and returns NULL, having cleaned up any new wsi pieces.< / td > < / tr >
2016-06-20 17:05:31 +08:00
< / table >
< / dd >
< / dl >
< p > LWS adopts the socket in http serving mode, it's ready to accept an upgrade to ws or just serve http.< / p >
< p > If your external code did not already read from the socket, you can use < a class = "el" href = "group__sock-adopt.html#gabe71b7462afb21c767bdc67334f305af" > lws_adopt_socket()< / a > instead.< / p >
< p > This api is guaranteed to use the data at < / p > < dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > readbuf< / td > < td > first, before reading from the socket.< / td > < / tr >
< / table >
< / dd >
< / dl >
< p > readbuf is limited to the size of the ah rx buf, currently 2048 bytes. < / p >
< / 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" >
2016-11-14 18:12:31 +08:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.12 < / li >
2016-06-20 17:05:31 +08:00
< / ul >
< / div >
< / body >
< / html >
