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_connect</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_connect</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="#AUTHORS">AUTHORS</a><br>
29*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
30*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
31*91df013fSAsim Jamshed
32*91df013fSAsim Jamshed<hr>
33*91df013fSAsim Jamshed
34*91df013fSAsim Jamshed
35*91df013fSAsim Jamshed<h2>NAME
36*91df013fSAsim Jamshed<a name="NAME"></a>
37*91df013fSAsim Jamshed</h2>
38*91df013fSAsim Jamshed
39*91df013fSAsim Jamshed
40*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_connect
41*91df013fSAsim Jamshed&minus; create a connection on an mTCP socket</p>
42*91df013fSAsim Jamshed
43*91df013fSAsim Jamshed<h2>SYNOPSIS
44*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
45*91df013fSAsim Jamshed</h2>
46*91df013fSAsim Jamshed
47*91df013fSAsim Jamshed
48*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
49*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
50*91df013fSAsim Jamshed
51*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
52*91df013fSAsim Jamshedmtcp_connect(mctx_t</b> <i>mctx</i><b>, int</b>
53*91df013fSAsim Jamshed<i>sockid</i><b>, const struct sockaddr *</b><i>addr</i><b>,
54*91df013fSAsim Jamshedsocklen_t</b> <i>addrlen</i><b>);</b></p>
55*91df013fSAsim Jamshed
56*91df013fSAsim Jamshed<h2>DESCRIPTION
57*91df013fSAsim Jamshed<a name="DESCRIPTION"></a>
58*91df013fSAsim Jamshed</h2>
59*91df013fSAsim Jamshed
60*91df013fSAsim Jamshed
61*91df013fSAsim Jamshed
62*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_connect</b>()
63*91df013fSAsim Jamshedconnects the socket referred via <i>sockid</i> argument to
64*91df013fSAsim Jamshedthe TCP peer whose address and port number are filled by the
65*91df013fSAsim Jamsheduser in <i>addr</i> structure in network byte order. The
66*91df013fSAsim Jamshed<i>addrlen</i> argument specifies the size of the
67*91df013fSAsim Jamshed<i>addr</i> address in bytes. The user is responsible for
68*91df013fSAsim Jamshedallocating memory for <i>addr</i> and <i>addrlen</i>
69*91df013fSAsim Jamshedarguments. A successful invocation of <b>mtcp_connect()</b>
70*91df013fSAsim Jamshedcall yields in a connection of the socket to its peer
71*91df013fSAsim Jamshedendpoint.</p>
72*91df013fSAsim Jamshed
73*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An
74*91df013fSAsim Jamshed<b>mtcp_connect</b>() call takes an additional argument
75*91df013fSAsim Jamshednamed <i>mctx</i> that represents the per-core mTCP context
76*91df013fSAsim Jamshedin an application (see <b>mtcp_create_context()</b> for
77*91df013fSAsim Jamsheddetails). The user is expected to use a specific
78*91df013fSAsim Jamshed&lt;srcipaddr, srctcpport, destipaddr, desttcpport&gt; tuple
79*91df013fSAsim Jamshedwhich ensures that bidirectional traffic of the connection
80*91df013fSAsim Jamshedis handled by the same <i>mctx</i> context. See
81*91df013fSAsim Jamshed<b>mtcp_init_rss()</b> man page for details.</p>
82*91df013fSAsim Jamshed
83*91df013fSAsim Jamshed<h2>RETURN VALUE
84*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
85*91df013fSAsim Jamshed</h2>
86*91df013fSAsim Jamshed
87*91df013fSAsim Jamshed
88*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
89*91df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
90*91df013fSAsim Jamshedset appropriately.</p>
91*91df013fSAsim Jamshed
92*91df013fSAsim Jamshed<h2>ERRORS
93*91df013fSAsim Jamshed<a name="ERRORS"></a>
94*91df013fSAsim Jamshed</h2>
95*91df013fSAsim Jamshed
96*91df013fSAsim Jamshed
97*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
98*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
99*91df013fSAsim Jamshed<tr valign="top" align="left">
100*91df013fSAsim Jamshed<td width="11%"></td>
101*91df013fSAsim Jamshed<td width="18%">
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed
104*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EAFNOSUPPORT</b></p></td>
105*91df013fSAsim Jamshed<td width="5%"></td>
106*91df013fSAsim Jamshed<td width="66%">
107*91df013fSAsim Jamshed
108*91df013fSAsim Jamshed
109*91df013fSAsim Jamshed<p style="margin-top: 1em">The size of the <i>addrlen</i>
110*91df013fSAsim Jamshedargument passed is invalid.</p></td></tr>
111*91df013fSAsim Jamshed<tr valign="top" align="left">
112*91df013fSAsim Jamshed<td width="11%"></td>
113*91df013fSAsim Jamshed<td width="18%">
114*91df013fSAsim Jamshed
115*91df013fSAsim Jamshed
116*91df013fSAsim Jamshed<p><b>EALREADY</b></p></td>
117*91df013fSAsim Jamshed<td width="5%"></td>
118*91df013fSAsim Jamshed<td width="66%">
119*91df013fSAsim Jamshed
120*91df013fSAsim Jamshed
121*91df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> descriptor is
122*91df013fSAsim Jamshedalready connected (with a TCP state &lt; <b>ESTABLISHED</b>)
123*91df013fSAsim Jamshedto a peer endpoint.</p></td></tr>
124*91df013fSAsim Jamshed<tr valign="top" align="left">
125*91df013fSAsim Jamshed<td width="11%"></td>
126*91df013fSAsim Jamshed<td width="18%">
127*91df013fSAsim Jamshed
128*91df013fSAsim Jamshed
129*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
130*91df013fSAsim Jamshed<td width="5%"></td>
131*91df013fSAsim Jamshed<td width="66%">
132*91df013fSAsim Jamshed
133*91df013fSAsim Jamshed
134*91df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
135*91df013fSAsim Jamshedcreating a connection.</p></td></tr>
136*91df013fSAsim Jamshed<tr valign="top" align="left">
137*91df013fSAsim Jamshed<td width="11%"></td>
138*91df013fSAsim Jamshed<td width="18%">
139*91df013fSAsim Jamshed
140*91df013fSAsim Jamshed
141*91df013fSAsim Jamshed<p><b>EFAULT</b></p></td>
142*91df013fSAsim Jamshed<td width="5%"></td>
143*91df013fSAsim Jamshed<td width="66%">
144*91df013fSAsim Jamshed
145*91df013fSAsim Jamshed
146*91df013fSAsim Jamshed<p>The <i>addr</i> argument passed is NULL.</p></td></tr>
147*91df013fSAsim Jamshed<tr valign="top" align="left">
148*91df013fSAsim Jamshed<td width="11%"></td>
149*91df013fSAsim Jamshed<td width="18%">
150*91df013fSAsim Jamshed
151*91df013fSAsim Jamshed
152*91df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
153*91df013fSAsim Jamshed<td width="5%"></td>
154*91df013fSAsim Jamshed<td width="66%">
155*91df013fSAsim Jamshed
156*91df013fSAsim Jamshed
157*91df013fSAsim Jamshed<p>Connection request for the given <i>addr</i> is invalid
158*91df013fSAsim Jamshed(due to incorrect &lt;addr,port&gt;-to-NIC_queue
159*91df013fSAsim Jamshedbinding).</p> </td></tr>
160*91df013fSAsim Jamshed<tr valign="top" align="left">
161*91df013fSAsim Jamshed<td width="11%"></td>
162*91df013fSAsim Jamshed<td width="18%">
163*91df013fSAsim Jamshed
164*91df013fSAsim Jamshed
165*91df013fSAsim Jamshed<p><b>EISCONN</b></p></td>
166*91df013fSAsim Jamshed<td width="5%"></td>
167*91df013fSAsim Jamshed<td width="66%">
168*91df013fSAsim Jamshed
169*91df013fSAsim Jamshed
170*91df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> descriptor
171*91df013fSAsim Jamshedalready has an established connection with a peer
172*91df013fSAsim Jamshedendpoint.</p> </td></tr>
173*91df013fSAsim Jamshed<tr valign="top" align="left">
174*91df013fSAsim Jamshed<td width="11%"></td>
175*91df013fSAsim Jamshed<td width="18%">
176*91df013fSAsim Jamshed
177*91df013fSAsim Jamshed
178*91df013fSAsim Jamshed<p><b>ENOMEM</b></p></td>
179*91df013fSAsim Jamshed<td width="5%"></td>
180*91df013fSAsim Jamshed<td width="66%">
181*91df013fSAsim Jamshed
182*91df013fSAsim Jamshed
183*91df013fSAsim Jamshed<p>Connection failed due to insufficient memory.</p></td></tr>
184*91df013fSAsim Jamshed<tr valign="top" align="left">
185*91df013fSAsim Jamshed<td width="11%"></td>
186*91df013fSAsim Jamshed<td width="18%">
187*91df013fSAsim Jamshed
188*91df013fSAsim Jamshed
189*91df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
190*91df013fSAsim Jamshed<td width="5%"></td>
191*91df013fSAsim Jamshed<td width="66%">
192*91df013fSAsim Jamshed
193*91df013fSAsim Jamshed
194*91df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> does not have a
195*91df013fSAsim Jamshedvalid socket type.</p></td></tr>
196*91df013fSAsim Jamshed<tr valign="top" align="left">
197*91df013fSAsim Jamshed<td width="11%"></td>
198*91df013fSAsim Jamshed<td width="18%">
199*91df013fSAsim Jamshed
200*91df013fSAsim Jamshed
201*91df013fSAsim Jamshed<p><b>ETIMEDOUT</b></p></td>
202*91df013fSAsim Jamshed<td width="5%"></td>
203*91df013fSAsim Jamshed<td width="66%">
204*91df013fSAsim Jamshed
205*91df013fSAsim Jamshed
206*91df013fSAsim Jamshed<p>Connection failure due to TCP timeout.</p></td></tr>
207*91df013fSAsim Jamshed</table>
208*91df013fSAsim Jamshed
209*91df013fSAsim Jamshed<h2>AUTHORS
210*91df013fSAsim Jamshed<a name="AUTHORS"></a>
211*91df013fSAsim Jamshed</h2>
212*91df013fSAsim Jamshed
213*91df013fSAsim Jamshed
214*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
215*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
216*91df013fSAsim Jamshed
217*91df013fSAsim Jamshed<h2>SEE ALSO
218*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
219*91df013fSAsim Jamshed</h2>
220*91df013fSAsim Jamshed
221*91df013fSAsim Jamshed
222*91df013fSAsim Jamshed
223*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
224*91df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
225*91df013fSAsim Jamshed<b>mtcp_socket</b>(), <b>mtcp_read</b>(),
226*91df013fSAsim Jamshed<b>mtcp_write</b>()</p>
227*91df013fSAsim Jamshed
228*91df013fSAsim Jamshed<h2>COLOPHON
229*91df013fSAsim Jamshed<a name="COLOPHON"></a>
230*91df013fSAsim Jamshed</h2>
231*91df013fSAsim Jamshed
232*91df013fSAsim Jamshed
233*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
234*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
235*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
236*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
237*91df013fSAsim Jamshed<hr>
238*91df013fSAsim Jamshed</body>
239*91df013fSAsim Jamshed</html>
240