1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Wed Feb  1 23:55:12 2017 -->
3*91df013fSAsim Jamshed<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4*91df013fSAsim Jamshed"http://www.w3.org/TR/html4/loose.dtd">
5*91df013fSAsim Jamshed<html>
6*91df013fSAsim Jamshed<head>
7*91df013fSAsim Jamshed<meta name="generator" content="groff -Thtml, see www.gnu.org">
8*91df013fSAsim Jamshed<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9*91df013fSAsim Jamshed<meta name="Content-Style" content="text/css">
10*91df013fSAsim Jamshed<style type="text/css">
11*91df013fSAsim Jamshed       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
12*91df013fSAsim Jamshed       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
13*91df013fSAsim Jamshed       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
14*91df013fSAsim Jamshed       h1      { text-align: center }
15*91df013fSAsim Jamshed</style>
16*91df013fSAsim Jamshed<title>mtcp_accept</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_accept</h1>
22*91df013fSAsim Jamshed
23*91df013fSAsim Jamshed<a href="#NAME">NAME</a><br>
24*91df013fSAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br>
25*91df013fSAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br>
26*91df013fSAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br>
27*91df013fSAsim Jamshed<a href="#ERRORS">ERRORS</a><br>
28*91df013fSAsim Jamshed<a href="#NOTES">NOTES</a><br>
29*91df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
30*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
31*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
32*91df013fSAsim Jamshed
33*91df013fSAsim Jamshed<hr>
34*91df013fSAsim Jamshed
35*91df013fSAsim Jamshed
36*91df013fSAsim Jamshed<h2>NAME
37*91df013fSAsim Jamshed<a name="NAME"></a>
38*91df013fSAsim Jamshed</h2>
39*91df013fSAsim Jamshed
40*91df013fSAsim Jamshed
41*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_accept
42*91df013fSAsim Jamshed&minus; accept a connection on an mTCP socket</p>
43*91df013fSAsim Jamshed
44*91df013fSAsim Jamshed<h2>SYNOPSIS
45*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
46*91df013fSAsim Jamshed</h2>
47*91df013fSAsim Jamshed
48*91df013fSAsim Jamshed
49*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
50*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
51*91df013fSAsim Jamshed
52*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
53*91df013fSAsim Jamshedmtcp_accept(mctx_t</b> <i>mctx</i><b>, int</b>
54*91df013fSAsim Jamshed<i>sockid</i><b>, struct sockaddr *</b><i>addr</i><b>,
55*91df013fSAsim Jamshedsocklen_t *</b><i>addrlen</i><b>);</b></p>
56*91df013fSAsim Jamshed
57*91df013fSAsim Jamshed<h2>DESCRIPTION
58*91df013fSAsim Jamshed<a name="DESCRIPTION"></a>
59*91df013fSAsim Jamshed</h2>
60*91df013fSAsim Jamshed
61*91df013fSAsim Jamshed
62*91df013fSAsim Jamshed
63*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_accept</b>()
64*91df013fSAsim Jamshedfunction is used to accept an incoming connection request
65*91df013fSAsim Jamshedfrom a TCP client. During a successful <b>mtcp_accept()</b>
66*91df013fSAsim Jamshedcall, the mTCP stack extracts the first connection request
67*91df013fSAsim Jamshedfrom the listening queue of pending connections associated
68*91df013fSAsim Jamshedwith the passive socket ID <i>sockid.</i> It then creates a
69*91df013fSAsim Jamshednew socket and returns its corresponding socket ID to the
70*91df013fSAsim Jamsheduser. The newly created socket (that is returned) can be
71*91df013fSAsim Jamshedused to communicate with the TCP client while the original
72*91df013fSAsim Jamshedsocket <i>sockid</i> is unaffected by this call. The passive
73*91df013fSAsim Jamshedsocket represented by the <i>sockid</i> socket descriptor
74*91df013fSAsim Jamshedshould be bound to a local address using <b>mtcp_bind()</b>
75*91df013fSAsim Jamshedfunction and should be listening for connections by calling
76*91df013fSAsim Jamshed<b>mtcp_listen()</b> function before it can be used for
77*91df013fSAsim Jamshedaccepting new connection requests.</p>
78*91df013fSAsim Jamshed
79*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The <i>addr</i>
80*91df013fSAsim Jamshedargument is a pointer to <i>sockaddr</i> structure that gets
81*91df013fSAsim Jamshedfilled up with the address of the peer node while the
82*91df013fSAsim Jamshed<i>addrlen</i> field contains the size of the peer address.
83*91df013fSAsim JamshedIf the <i>addr</i> argument is NULL, nothing is filled in
84*91df013fSAsim Jamshedand as a result, <i>addrlen</i> is not used and should also
85*91df013fSAsim Jamshedbe NULL.</p>
86*91df013fSAsim Jamshed
87*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">If no pending
88*91df013fSAsim Jamshedconnections are present on the queue, mtcp_accept() fails
89*91df013fSAsim Jamshedwith error <b>EAGAIN</b> errno.</p>
90*91df013fSAsim Jamshed
91*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">In order to be
92*91df013fSAsim Jamshednotified of incoming connections on a socket, the user can
93*91df013fSAsim Jamsheduse <b>mtcp_epoll_wait()</b> function call. A readable event
94*91df013fSAsim Jamshedis delivered when a new connection arrives on the listening
95*91df013fSAsim Jamshedsocket.</p>
96*91df013fSAsim Jamshed
97*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An
98*91df013fSAsim Jamshed<b>mtcp_accept</b>() call takes an additional argument named
99*91df013fSAsim Jamshed<i>mctx</i> that represents the per-core mTCP context in an
100*91df013fSAsim Jamshedapplication (see <b>mtcp_create_context()</b> for
101*91df013fSAsim Jamsheddetails).</p>
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed<h2>RETURN VALUE
104*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
105*91df013fSAsim Jamshed</h2>
106*91df013fSAsim Jamshed
107*91df013fSAsim Jamshed
108*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns an mTCP
109*91df013fSAsim Jamsheddescriptor ID of the newly created active mTCP socket; -1 on
110*91df013fSAsim Jamshedfailure. In case of failure, <i>errno</i> is set
111*91df013fSAsim Jamshedappropriately.</p>
112*91df013fSAsim Jamshed
113*91df013fSAsim Jamshed<h2>ERRORS
114*91df013fSAsim Jamshed<a name="ERRORS"></a>
115*91df013fSAsim Jamshed</h2>
116*91df013fSAsim Jamshed
117*91df013fSAsim Jamshed
118*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
119*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
120*91df013fSAsim Jamshed<tr valign="top" align="left">
121*91df013fSAsim Jamshed<td width="11%"></td>
122*91df013fSAsim Jamshed<td width="9%">
123*91df013fSAsim Jamshed
124*91df013fSAsim Jamshed
125*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EAGAIN</b></p></td>
126*91df013fSAsim Jamshed<td width="6%"></td>
127*91df013fSAsim Jamshed<td width="74%">
128*91df013fSAsim Jamshed
129*91df013fSAsim Jamshed
130*91df013fSAsim Jamshed<p style="margin-top: 1em">No connections requests are
131*91df013fSAsim Jamshedavailable at the moment.</p></td></tr>
132*91df013fSAsim Jamshed<tr valign="top" align="left">
133*91df013fSAsim Jamshed<td width="11%"></td>
134*91df013fSAsim Jamshed<td width="9%">
135*91df013fSAsim Jamshed
136*91df013fSAsim Jamshed
137*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
138*91df013fSAsim Jamshed<td width="6%"></td>
139*91df013fSAsim Jamshed<td width="74%">
140*91df013fSAsim Jamshed
141*91df013fSAsim Jamshed
142*91df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
143*91df013fSAsim Jamshedaccepting connections.</p></td></tr>
144*91df013fSAsim Jamshed<tr valign="top" align="left">
145*91df013fSAsim Jamshed<td width="11%"></td>
146*91df013fSAsim Jamshed<td width="9%">
147*91df013fSAsim Jamshed
148*91df013fSAsim Jamshed
149*91df013fSAsim Jamshed<p><b>EINTR</b></p></td>
150*91df013fSAsim Jamshed<td width="6%"></td>
151*91df013fSAsim Jamshed<td width="74%">
152*91df013fSAsim Jamshed
153*91df013fSAsim Jamshed
154*91df013fSAsim Jamshed<p>The application thread is scheduled to shut down.</p></td></tr>
155*91df013fSAsim Jamshed<tr valign="top" align="left">
156*91df013fSAsim Jamshed<td width="11%"></td>
157*91df013fSAsim Jamshed<td width="9%">
158*91df013fSAsim Jamshed
159*91df013fSAsim Jamshed
160*91df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
161*91df013fSAsim Jamshed<td width="6%"></td>
162*91df013fSAsim Jamshed<td width="74%">
163*91df013fSAsim Jamshed
164*91df013fSAsim Jamshed
165*91df013fSAsim Jamshed<p>The socket referred to by the <i>sockid</i> argument is
166*91df013fSAsim Jamshednot a listening (passive) socket.</p></td></tr>
167*91df013fSAsim Jamshed<tr valign="top" align="left">
168*91df013fSAsim Jamshed<td width="11%"></td>
169*91df013fSAsim Jamshed<td width="9%">
170*91df013fSAsim Jamshed
171*91df013fSAsim Jamshed
172*91df013fSAsim Jamshed<p><b>ENFILE</b></p></td>
173*91df013fSAsim Jamshed<td width="6%"></td>
174*91df013fSAsim Jamshed<td width="74%">
175*91df013fSAsim Jamshed
176*91df013fSAsim Jamshed
177*91df013fSAsim Jamshed<p>New active socket could not be created as the mTCP core
178*91df013fSAsim Jamshedis out of socket descriptors at the moment.</p></td></tr>
179*91df013fSAsim Jamshed</table>
180*91df013fSAsim Jamshed
181*91df013fSAsim Jamshed<h2>NOTES
182*91df013fSAsim Jamshed<a name="NOTES"></a>
183*91df013fSAsim Jamshed</h2>
184*91df013fSAsim Jamshed
185*91df013fSAsim Jamshed
186*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">For performance
187*91df013fSAsim Jamshedreasons, it is recommended that the <i>same</i> thread
188*91df013fSAsim Jamshed(represented by <i>mctx</i> argument) that spawns the active
189*91df013fSAsim Jamshedsocket via <b>mtcp_accept()</b> should handle operations
190*91df013fSAsim Jamshed<b>(mtcp_read(), mtcp_write(),</b> and
191*91df013fSAsim Jamshed<b>mtcp_getsockopt())</b> on that socket for the entire
192*91df013fSAsim Jamshedlifetime of the connection (till <b>mtcp_close()).</b></p>
193*91df013fSAsim Jamshed
194*91df013fSAsim Jamshed<h2>AUTHORS
195*91df013fSAsim Jamshed<a name="AUTHORS"></a>
196*91df013fSAsim Jamshed</h2>
197*91df013fSAsim Jamshed
198*91df013fSAsim Jamshed
199*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
200*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
201*91df013fSAsim Jamshed
202*91df013fSAsim Jamshed<h2>SEE ALSO
203*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
204*91df013fSAsim Jamshed</h2>
205*91df013fSAsim Jamshed
206*91df013fSAsim Jamshed
207*91df013fSAsim Jamshed
208*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
209*91df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_socket</b>(),
210*91df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_read</b>(),
211*91df013fSAsim Jamshed<b>mtcp_write</b>()</p>
212*91df013fSAsim Jamshed
213*91df013fSAsim Jamshed<h2>COLOPHON
214*91df013fSAsim Jamshed<a name="COLOPHON"></a>
215*91df013fSAsim Jamshed</h2>
216*91df013fSAsim Jamshed
217*91df013fSAsim Jamshed
218*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
219*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
220*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
221*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
222*91df013fSAsim Jamshed<hr>
223*91df013fSAsim Jamshed</body>
224*91df013fSAsim Jamshed</html>
225