191df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*e5df9dc1SAsim Jamshed<!-- CreationDate: Wed Feb  1 22:24:31 2017 -->
391df013fSAsim Jamshed<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
491df013fSAsim Jamshed"http://www.w3.org/TR/html4/loose.dtd">
591df013fSAsim Jamshed<html>
691df013fSAsim Jamshed<head>
791df013fSAsim Jamshed<meta name="generator" content="groff -Thtml, see www.gnu.org">
891df013fSAsim Jamshed<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
991df013fSAsim Jamshed<meta name="Content-Style" content="text/css">
1091df013fSAsim Jamshed<style type="text/css">
1191df013fSAsim Jamshed       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
1291df013fSAsim Jamshed       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
1391df013fSAsim Jamshed       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
1491df013fSAsim Jamshed       h1      { text-align: center }
1591df013fSAsim Jamshed</style>
1691df013fSAsim Jamshed<title>mtcp_connect</title>
17*e5df9dc1SAsim Jamshed<link rel="stylesheet" href="./common.css">
1891df013fSAsim Jamshed</head>
1991df013fSAsim Jamshed<body>
20*e5df9dc1SAsim Jamshed<div class="main">
2191df013fSAsim Jamshed<h1 align="center">mtcp_connect</h1>
22*e5df9dc1SAsim Jamshed<!--
2391df013fSAsim Jamshed<a href="#NAME">NAME</a><br>
2491df013fSAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br>
2591df013fSAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br>
2691df013fSAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br>
2791df013fSAsim Jamshed<a href="#ERRORS">ERRORS</a><br>
2891df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
2991df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
3091df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
3191df013fSAsim Jamshed<hr>
32*e5df9dc1SAsim Jamshed-->
3391df013fSAsim Jamshed
3491df013fSAsim Jamshed<h2>NAME
3591df013fSAsim Jamshed<a name="NAME"></a>
3691df013fSAsim Jamshed</h2>
3791df013fSAsim Jamshed
3891df013fSAsim Jamshed
3991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_connect
4091df013fSAsim Jamshed&minus; create a connection on an mTCP socket</p>
4191df013fSAsim Jamshed
4291df013fSAsim Jamshed<h2>SYNOPSIS
4391df013fSAsim Jamshed<a name="SYNOPSIS"></a>
4491df013fSAsim Jamshed</h2>
4591df013fSAsim Jamshed
4691df013fSAsim Jamshed
4791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
4891df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
4991df013fSAsim Jamshed
5091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
5191df013fSAsim Jamshedmtcp_connect(mctx_t</b> <i>mctx</i><b>, int</b>
5291df013fSAsim Jamshed<i>sockid</i><b>, const struct sockaddr *</b><i>addr</i><b>,
5391df013fSAsim Jamshedsocklen_t</b> <i>addrlen</i><b>);</b></p>
5491df013fSAsim Jamshed
5591df013fSAsim Jamshed<h2>DESCRIPTION
5691df013fSAsim Jamshed<a name="DESCRIPTION"></a>
5791df013fSAsim Jamshed</h2>
5891df013fSAsim Jamshed
5991df013fSAsim Jamshed
6091df013fSAsim Jamshed
6191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_connect</b>()
6291df013fSAsim Jamshedconnects the socket referred via <i>sockid</i> argument to
6391df013fSAsim Jamshedthe TCP peer whose address and port number are filled by the
6491df013fSAsim Jamsheduser in <i>addr</i> structure in network byte order. The
6591df013fSAsim Jamshed<i>addrlen</i> argument specifies the size of the
6691df013fSAsim Jamshed<i>addr</i> address in bytes. The user is responsible for
6791df013fSAsim Jamshedallocating memory for <i>addr</i> and <i>addrlen</i>
6891df013fSAsim Jamshedarguments. A successful invocation of <b>mtcp_connect()</b>
6991df013fSAsim Jamshedcall yields in a connection of the socket to its peer
7091df013fSAsim Jamshedendpoint.</p>
7191df013fSAsim Jamshed
7291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An
7391df013fSAsim Jamshed<b>mtcp_connect</b>() call takes an additional argument
7491df013fSAsim Jamshednamed <i>mctx</i> that represents the per-core mTCP context
7591df013fSAsim Jamshedin an application (see <b>mtcp_create_context()</b> for
7691df013fSAsim Jamsheddetails). The user is expected to use a specific
7791df013fSAsim Jamshed&lt;srcipaddr, srctcpport, destipaddr, desttcpport&gt; tuple
7891df013fSAsim Jamshedwhich ensures that bidirectional traffic of the connection
7991df013fSAsim Jamshedis handled by the same <i>mctx</i> context. See
8091df013fSAsim Jamshed<b>mtcp_init_rss()</b> man page for details.</p>
8191df013fSAsim Jamshed
8291df013fSAsim Jamshed<h2>RETURN VALUE
8391df013fSAsim Jamshed<a name="RETURN VALUE"></a>
8491df013fSAsim Jamshed</h2>
8591df013fSAsim Jamshed
8691df013fSAsim Jamshed
8791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
8891df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
8991df013fSAsim Jamshedset appropriately.</p>
9091df013fSAsim Jamshed
9191df013fSAsim Jamshed<h2>ERRORS
9291df013fSAsim Jamshed<a name="ERRORS"></a>
9391df013fSAsim Jamshed</h2>
9491df013fSAsim Jamshed
9591df013fSAsim Jamshed
9691df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
9791df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
9891df013fSAsim Jamshed<tr valign="top" align="left">
9991df013fSAsim Jamshed<td width="11%"></td>
10091df013fSAsim Jamshed<td width="18%">
10191df013fSAsim Jamshed
10291df013fSAsim Jamshed
10391df013fSAsim Jamshed<p style="margin-top: 1em"><b>EAFNOSUPPORT</b></p></td>
10491df013fSAsim Jamshed<td width="5%"></td>
10591df013fSAsim Jamshed<td width="66%">
10691df013fSAsim Jamshed
10791df013fSAsim Jamshed
10891df013fSAsim Jamshed<p style="margin-top: 1em">The size of the <i>addrlen</i>
10991df013fSAsim Jamshedargument passed is invalid.</p></td></tr>
11091df013fSAsim Jamshed<tr valign="top" align="left">
11191df013fSAsim Jamshed<td width="11%"></td>
11291df013fSAsim Jamshed<td width="18%">
11391df013fSAsim Jamshed
11491df013fSAsim Jamshed
11591df013fSAsim Jamshed<p><b>EALREADY</b></p></td>
11691df013fSAsim Jamshed<td width="5%"></td>
11791df013fSAsim Jamshed<td width="66%">
11891df013fSAsim Jamshed
11991df013fSAsim Jamshed
12091df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> descriptor is
12191df013fSAsim Jamshedalready connected (with a TCP state &lt; <b>ESTABLISHED</b>)
12291df013fSAsim Jamshedto a peer endpoint.</p></td></tr>
12391df013fSAsim Jamshed<tr valign="top" align="left">
12491df013fSAsim Jamshed<td width="11%"></td>
12591df013fSAsim Jamshed<td width="18%">
12691df013fSAsim Jamshed
12791df013fSAsim Jamshed
12891df013fSAsim Jamshed<p><b>EBADF</b></p></td>
12991df013fSAsim Jamshed<td width="5%"></td>
13091df013fSAsim Jamshed<td width="66%">
13191df013fSAsim Jamshed
13291df013fSAsim Jamshed
13391df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
13491df013fSAsim Jamshedcreating a connection.</p></td></tr>
13591df013fSAsim Jamshed<tr valign="top" align="left">
13691df013fSAsim Jamshed<td width="11%"></td>
13791df013fSAsim Jamshed<td width="18%">
13891df013fSAsim Jamshed
13991df013fSAsim Jamshed
14091df013fSAsim Jamshed<p><b>EFAULT</b></p></td>
14191df013fSAsim Jamshed<td width="5%"></td>
14291df013fSAsim Jamshed<td width="66%">
14391df013fSAsim Jamshed
14491df013fSAsim Jamshed
14591df013fSAsim Jamshed<p>The <i>addr</i> argument passed is NULL.</p></td></tr>
14691df013fSAsim Jamshed<tr valign="top" align="left">
14791df013fSAsim Jamshed<td width="11%"></td>
14891df013fSAsim Jamshed<td width="18%">
14991df013fSAsim Jamshed
15091df013fSAsim Jamshed
15191df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
15291df013fSAsim Jamshed<td width="5%"></td>
15391df013fSAsim Jamshed<td width="66%">
15491df013fSAsim Jamshed
15591df013fSAsim Jamshed
15691df013fSAsim Jamshed<p>Connection request for the given <i>addr</i> is invalid
15791df013fSAsim Jamshed(due to incorrect &lt;addr,port&gt;-to-NIC_queue
15891df013fSAsim Jamshedbinding).</p> </td></tr>
15991df013fSAsim Jamshed<tr valign="top" align="left">
16091df013fSAsim Jamshed<td width="11%"></td>
16191df013fSAsim Jamshed<td width="18%">
16291df013fSAsim Jamshed
16391df013fSAsim Jamshed
16491df013fSAsim Jamshed<p><b>EISCONN</b></p></td>
16591df013fSAsim Jamshed<td width="5%"></td>
16691df013fSAsim Jamshed<td width="66%">
16791df013fSAsim Jamshed
16891df013fSAsim Jamshed
16991df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> descriptor
17091df013fSAsim Jamshedalready has an established connection with a peer
17191df013fSAsim Jamshedendpoint.</p> </td></tr>
17291df013fSAsim Jamshed<tr valign="top" align="left">
17391df013fSAsim Jamshed<td width="11%"></td>
17491df013fSAsim Jamshed<td width="18%">
17591df013fSAsim Jamshed
17691df013fSAsim Jamshed
17791df013fSAsim Jamshed<p><b>ENOMEM</b></p></td>
17891df013fSAsim Jamshed<td width="5%"></td>
17991df013fSAsim Jamshed<td width="66%">
18091df013fSAsim Jamshed
18191df013fSAsim Jamshed
18291df013fSAsim Jamshed<p>Connection failed due to insufficient memory.</p></td></tr>
18391df013fSAsim Jamshed<tr valign="top" align="left">
18491df013fSAsim Jamshed<td width="11%"></td>
18591df013fSAsim Jamshed<td width="18%">
18691df013fSAsim Jamshed
18791df013fSAsim Jamshed
18891df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
18991df013fSAsim Jamshed<td width="5%"></td>
19091df013fSAsim Jamshed<td width="66%">
19191df013fSAsim Jamshed
19291df013fSAsim Jamshed
19391df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> does not have a
19491df013fSAsim Jamshedvalid socket type.</p></td></tr>
19591df013fSAsim Jamshed<tr valign="top" align="left">
19691df013fSAsim Jamshed<td width="11%"></td>
19791df013fSAsim Jamshed<td width="18%">
19891df013fSAsim Jamshed
19991df013fSAsim Jamshed
20091df013fSAsim Jamshed<p><b>ETIMEDOUT</b></p></td>
20191df013fSAsim Jamshed<td width="5%"></td>
20291df013fSAsim Jamshed<td width="66%">
20391df013fSAsim Jamshed
20491df013fSAsim Jamshed
20591df013fSAsim Jamshed<p>Connection failure due to TCP timeout.</p></td></tr>
20691df013fSAsim Jamshed</table>
20791df013fSAsim Jamshed
20891df013fSAsim Jamshed<h2>AUTHORS
20991df013fSAsim Jamshed<a name="AUTHORS"></a>
21091df013fSAsim Jamshed</h2>
21191df013fSAsim Jamshed
21291df013fSAsim Jamshed
213*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS
214*e5df9dc1SAsim Jamsheddevelopment team &lt;[email protected]&gt;</p>
21591df013fSAsim Jamshed
21691df013fSAsim Jamshed<h2>SEE ALSO
21791df013fSAsim Jamshed<a name="SEE ALSO"></a>
21891df013fSAsim Jamshed</h2>
21991df013fSAsim Jamshed
22091df013fSAsim Jamshed
22191df013fSAsim Jamshed
22291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
22391df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
22491df013fSAsim Jamshed<b>mtcp_socket</b>(), <b>mtcp_read</b>(),
22591df013fSAsim Jamshed<b>mtcp_write</b>()</p>
22691df013fSAsim Jamshed
22791df013fSAsim Jamshed<h2>COLOPHON
22891df013fSAsim Jamshed<a name="COLOPHON"></a>
22991df013fSAsim Jamshed</h2>
23091df013fSAsim Jamshed
23191df013fSAsim Jamshed
23291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
23391df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
23491df013fSAsim Jamshedof the project, and information about reporting bugs, can be
23591df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
236*e5df9dc1SAsim Jamshed<!--  <hr> -->
237*e5df9dc1SAsim Jamshed<br>
238*e5df9dc1SAsim Jamshed<div class="footer">
239*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
240*e5df9dc1SAsim Jamshed</div>
241*e5df9dc1SAsim Jamshed</div>
24291df013fSAsim Jamshed</body>
24391df013fSAsim Jamshed</html>
244