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_read</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_read</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_read
4091df013fSAsim Jamshed&minus; read bytestream from 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>ssize_t
5191df013fSAsim Jamshedmtcp_read(mctx_t</b> <i>mctx</i><b>, int</b>
5291df013fSAsim Jamshed<i>sockid</i><b>, char *</b><i>buf</i><b>, size_t</b>
5391df013fSAsim Jamshed<i>len</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_read</b>()
6291df013fSAsim Jamshedcan be used to read up to <i>len</i> number of bytes from
6391df013fSAsim JamshedmTCP socket via socket descriptor <i>sockid</i> into the
6491df013fSAsim Jamshedbuffer starting at <i>buf.</i> It is the responsibility of
6591df013fSAsim Jamshedthe user to allocate memory for <i>buf</i> array.</p>
6691df013fSAsim Jamshed
6791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">For cases when
6891df013fSAsim Jamshedthe total number of buffered unread bytes in the socket are
6991df013fSAsim Jamshedless than <i>len,</i> <b>mtcp_read()</b> copies entire data
7091df013fSAsim Jamshedto <i>buf</i> and returns the actual number of bytes that
7191df013fSAsim Jamshedcan be used by the application.</p>
7291df013fSAsim Jamshed
7391df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An
7491df013fSAsim Jamshed<b>mtcp_read</b>() call takes an additional argument named
7591df013fSAsim Jamshed<i>mctx</i> that represents the per-core mTCP context in an
7691df013fSAsim Jamshedapplication (see <b>mtcp_create_context()</b> for
7791df013fSAsim Jamsheddetails).</p>
7891df013fSAsim Jamshed
7991df013fSAsim Jamshed<h2>RETURN VALUE
8091df013fSAsim Jamshed<a name="RETURN VALUE"></a>
8191df013fSAsim Jamshed</h2>
8291df013fSAsim Jamshed
8391df013fSAsim Jamshed
8491df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">On success, the
8591df013fSAsim Jamshednumber of bytes read is returned. It is not an error if this
8691df013fSAsim Jamshednumber is smaller than the number of bytes requested; this
8791df013fSAsim Jamshedmay happen when the socket has fewer number of bytes
8891df013fSAsim Jamshedbuffered at that moment. On all errors, -1 is returned and
8991df013fSAsim Jamshed<i>errno</i> is set 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="12%">
10191df013fSAsim Jamshed
10291df013fSAsim Jamshed
10391df013fSAsim Jamshed<p style="margin-top: 1em"><b>EBADF</b></p></td>
10491df013fSAsim Jamshed<td width="3%"></td>
10591df013fSAsim Jamshed<td width="74%">
10691df013fSAsim Jamshed
10791df013fSAsim Jamshed
10891df013fSAsim Jamshed<p style="margin-top: 1em">The socket descriptor
10991df013fSAsim Jamshed<i>sockid</i> is invalid.</p></td></tr>
11091df013fSAsim Jamshed<tr valign="top" align="left">
11191df013fSAsim Jamshed<td width="11%"></td>
11291df013fSAsim Jamshed<td width="12%">
11391df013fSAsim Jamshed
11491df013fSAsim Jamshed
11591df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
11691df013fSAsim Jamshed<td width="3%"></td>
11791df013fSAsim Jamshed<td width="74%">
11891df013fSAsim Jamshed
11991df013fSAsim Jamshed
12091df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> has invalid
12191df013fSAsim Jamshed<i>type</i></p> </td></tr>
12291df013fSAsim Jamshed<tr valign="top" align="left">
12391df013fSAsim Jamshed<td width="11%"></td>
12491df013fSAsim Jamshed<td width="12%">
12591df013fSAsim Jamshed
12691df013fSAsim Jamshed
12791df013fSAsim Jamshed<p><b>ENOTCONN</b></p></td>
12891df013fSAsim Jamshed<td width="3%"></td>
12991df013fSAsim Jamshed<td width="74%">
13091df013fSAsim Jamshed
13191df013fSAsim Jamshed
13291df013fSAsim Jamshed<p>Th socket referred to by <i>sockid</i> is in a TCP state
13391df013fSAsim Jamshedthat disallows read operations.</p></td></tr>
13491df013fSAsim Jamshed<tr valign="top" align="left">
13591df013fSAsim Jamshed<td width="11%"></td>
13691df013fSAsim Jamshed<td width="12%">
13791df013fSAsim Jamshed
13891df013fSAsim Jamshed
13991df013fSAsim Jamshed<p><b>EAGAIN</b></p></td>
14091df013fSAsim Jamshed<td width="3%"></td>
14191df013fSAsim Jamshed<td width="74%">
14291df013fSAsim Jamshed
14391df013fSAsim Jamshed
14491df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> does not have
14591df013fSAsim Jamshedany available bytes in its buffer for reading.</p></td></tr>
14691df013fSAsim Jamshed</table>
14791df013fSAsim Jamshed
14891df013fSAsim Jamshed<h2>AUTHORS
14991df013fSAsim Jamshed<a name="AUTHORS"></a>
15091df013fSAsim Jamshed</h2>
15191df013fSAsim Jamshed
15291df013fSAsim Jamshed
153*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS
154*e5df9dc1SAsim Jamsheddevelopment team &lt;[email protected]&gt;</p>
15591df013fSAsim Jamshed
15691df013fSAsim Jamshed<h2>SEE ALSO
15791df013fSAsim Jamshed<a name="SEE ALSO"></a>
15891df013fSAsim Jamshed</h2>
15991df013fSAsim Jamshed
16091df013fSAsim Jamshed
16191df013fSAsim Jamshed
16291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
16391df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
16491df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_socket</b>(),
16591df013fSAsim Jamshed<b>mtcp_write</b>()</p>
16691df013fSAsim Jamshed
16791df013fSAsim Jamshed<h2>COLOPHON
16891df013fSAsim Jamshed<a name="COLOPHON"></a>
16991df013fSAsim Jamshed</h2>
17091df013fSAsim Jamshed
17191df013fSAsim Jamshed
17291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
17391df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
17491df013fSAsim Jamshedof the project, and information about reporting bugs, can be
17591df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
176*e5df9dc1SAsim Jamshed<!--<hr>-->
177*e5df9dc1SAsim Jamshed<br>
178*e5df9dc1SAsim Jamshed<div class="footer">
179*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
180*e5df9dc1SAsim Jamshed</div>
181*e5df9dc1SAsim Jamshed</div>
18291df013fSAsim Jamshed</body>
18391df013fSAsim Jamshed</html>
184