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_bind</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_bind</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_bind
4091df013fSAsim Jamshed&minus; bind an IP address to 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_bind(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_bind</b>()
6291df013fSAsim Jamshedcan be used to bind an IPv4 address (assigning a name) to an
6391df013fSAsim JamshedmTCP socket. This socket is referred to by the <i>sockid</i>
6491df013fSAsim Jamshedargument. The <i>addr</i> structure contains the address and
6591df013fSAsim Jamshedthe port number (both in network byte order) to be bound
6691df013fSAsim Jamshedwhile the <i>addrlen</i> specifies the size of the address
6791df013fSAsim Jamshedstructure pointing to <i>addr.</i> The actual structure
6891df013fSAsim Jamshedpassed for the <i>addr</i> argument is defined as:</p>
6991df013fSAsim Jamshed
7091df013fSAsim Jamshed<p style="margin-left:17%; margin-top: 1em">struct sockaddr
7191df013fSAsim Jamshed{ <br>
7291df013fSAsim Jamshedsa_family_t sa_family; /* AF_INET */ <br>
7391df013fSAsim Jamshedchar sa_data[14]; /* IPv4 address + TCP port */ <br>
7491df013fSAsim Jamshed}</p>
7591df013fSAsim Jamshed
7691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">It is necessary
7791df013fSAsim Jamshedto assign a local address using <b>mtcp_bind()</b> on a
7891df013fSAsim Jamshedpassive socket before it can be used to receive connections
7991df013fSAsim Jamshedusing <b>mtcp_accept().</b></p>
8091df013fSAsim Jamshed
8191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The
8291df013fSAsim Jamshed<b>mtcp_bind</b>() call takes an additional argument named
8391df013fSAsim Jamshed<i>mctx</i> that represents the per-core mTCP context in an
8491df013fSAsim Jamshedapplication (see <b>mtcp_create_context()</b> for
8591df013fSAsim Jamsheddetails).</p>
8691df013fSAsim Jamshed
8791df013fSAsim Jamshed<h2>RETURN VALUE
8891df013fSAsim Jamshed<a name="RETURN VALUE"></a>
8991df013fSAsim Jamshed</h2>
9091df013fSAsim Jamshed
9191df013fSAsim Jamshed
9291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
9391df013fSAsim Jamshedsuccess; -1 on failure. In case of failure, <i>errno</i> is
9491df013fSAsim Jamshedset appropriately.</p>
9591df013fSAsim Jamshed
9691df013fSAsim Jamshed<h2>ERRORS
9791df013fSAsim Jamshed<a name="ERRORS"></a>
9891df013fSAsim Jamshed</h2>
9991df013fSAsim Jamshed
10091df013fSAsim Jamshed
10191df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
10291df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
10391df013fSAsim Jamshed<tr valign="top" align="left">
10491df013fSAsim Jamshed<td width="11%"></td>
10591df013fSAsim Jamshed<td width="12%">
10691df013fSAsim Jamshed
10791df013fSAsim Jamshed
10891df013fSAsim Jamshed<p style="margin-top: 1em"><b>EBADF</b></p></td>
10991df013fSAsim Jamshed<td width="3%"></td>
11091df013fSAsim Jamshed<td width="74%">
11191df013fSAsim Jamshed
11291df013fSAsim Jamshed
11391df013fSAsim Jamshed<p style="margin-top: 1em"><i>sockid</i> is not a valid
11491df013fSAsim Jamshedsocket descriptor for binding to an address.</p></td></tr>
11591df013fSAsim Jamshed<tr valign="top" align="left">
11691df013fSAsim Jamshed<td width="11%"></td>
11791df013fSAsim Jamshed<td width="12%">
11891df013fSAsim Jamshed
11991df013fSAsim Jamshed
12091df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
12191df013fSAsim Jamshed<td width="3%"></td>
12291df013fSAsim Jamshed<td width="74%">
12391df013fSAsim Jamshed
12491df013fSAsim Jamshed
12591df013fSAsim Jamshed<p>The <i>addr</i> argument is NULL. This may also mean
12691df013fSAsim Jamshedthat an address is already bound to the current
12791df013fSAsim Jamshed<i>sockid</i> descriptor.</p></td></tr>
12891df013fSAsim Jamshed<tr valign="top" align="left">
12991df013fSAsim Jamshed<td width="11%"></td>
13091df013fSAsim Jamshed<td width="12%">
13191df013fSAsim Jamshed
13291df013fSAsim Jamshed
13391df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
13491df013fSAsim Jamshed<td width="3%"></td>
13591df013fSAsim Jamshed<td width="74%">
13691df013fSAsim Jamshed
13791df013fSAsim Jamshed
13891df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> has an invalid
13991df013fSAsim Jamshedtype.</p> </td></tr>
14091df013fSAsim Jamshed</table>
14191df013fSAsim Jamshed
14291df013fSAsim Jamshed<h2>AUTHORS
14391df013fSAsim Jamshed<a name="AUTHORS"></a>
14491df013fSAsim Jamshed</h2>
14591df013fSAsim Jamshed
14691df013fSAsim Jamshed
147*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS
148*e5df9dc1SAsim Jamsheddevelopment team &lt;[email protected]&gt;</p>
14991df013fSAsim Jamshed
15091df013fSAsim Jamshed<h2>SEE ALSO
15191df013fSAsim Jamshed<a name="SEE ALSO"></a>
15291df013fSAsim Jamshed</h2>
15391df013fSAsim Jamshed
15491df013fSAsim Jamshed
15591df013fSAsim Jamshed
15691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_socket</b>(),
15791df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
15891df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_read</b>(),
15991df013fSAsim Jamshed<b>mtcp_write</b>()</p>
16091df013fSAsim Jamshed
16191df013fSAsim Jamshed<h2>COLOPHON
16291df013fSAsim Jamshed<a name="COLOPHON"></a>
16391df013fSAsim Jamshed</h2>
16491df013fSAsim Jamshed
16591df013fSAsim Jamshed
16691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
16791df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
16891df013fSAsim Jamshedof the project, and information about reporting bugs, can be
16991df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
170*e5df9dc1SAsim Jamshed<!--<hr>-->
171*e5df9dc1SAsim Jamshed<br>
172*e5df9dc1SAsim Jamshed<div class="footer">
173*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
174*e5df9dc1SAsim Jamshed</div>
175*e5df9dc1SAsim Jamshed</div>
17691df013fSAsim Jamshed</body>
17791df013fSAsim Jamshed</html>
178