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_recv</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_recv</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_recv 4091df013fSAsim Jamshed− receive a message from a 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<mtcp_api.h></b></p> 4991df013fSAsim Jamshed 5091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>ssize_t 5191df013fSAsim Jamshedmtcp_recv(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>, int</b> <i>flags</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_recv</b>() 6291df013fSAsim Jamshedcall is normally used only on a <i>connected</i> socket (see 6391df013fSAsim Jamshed<b>mtcp_connect()</b>) and is identical to 6491df013fSAsim Jamshed<b>mtcp_read()</b> with <i>flags</i> value set to 0. The 6591df013fSAsim Jamshedfunction can be used to read up to <i>len</i> number of 6691df013fSAsim Jamshedbytes from mTCP socket via socket descriptor <i>sockid</i> 6791df013fSAsim Jamshedinto the buffer starting at <i>buf.</i> It is the 6891df013fSAsim Jamshedresponsibility of the user to allocate memory for <i>buf</i> 6991df013fSAsim Jamshedarray.</p> 7091df013fSAsim Jamshed 7191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">For cases when 7291df013fSAsim Jamshedthe total number of buffered unread bytes in the socket are 7391df013fSAsim Jamshedless than <i>len,</i> <b>mtcp_recv()</b> copies entire data 7491df013fSAsim Jamshedto <i>buf</i> and returns the actual number of bytes that 7591df013fSAsim Jamshedcan be used by the application.</p> 7691df013fSAsim Jamshed 7791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An 7891df013fSAsim Jamshed<b>mtcp_recv</b>() call takes an additional argument named 7991df013fSAsim Jamshed<i>mctx</i> that represents the per-core mTCP context in an 8091df013fSAsim Jamshedapplication (see <b>mtcp_create_context()</b> for 8191df013fSAsim Jamsheddetails).</p> 8291df013fSAsim Jamshed 8391df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The 8491df013fSAsim Jamshed<i>flags</i> argument to a <b>mtcp_recv()</b> call currently 8591df013fSAsim Jamshedaccepts only one non-zero value:</p> 8691df013fSAsim Jamshed 8791df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void" 8891df013fSAsim Jamshed cellspacing="0" cellpadding="0"> 8991df013fSAsim Jamshed<tr valign="top" align="left"> 9091df013fSAsim Jamshed<td width="11%"></td> 9191df013fSAsim Jamshed<td width="12%"> 9291df013fSAsim Jamshed 9391df013fSAsim Jamshed 9491df013fSAsim Jamshed<p><b>MSG_PEEK</b></p></td> 9591df013fSAsim Jamshed<td width="3%"></td> 9691df013fSAsim Jamshed<td width="74%"> 9791df013fSAsim Jamshed 9891df013fSAsim Jamshed 9991df013fSAsim Jamshed<p>This flag causes the receive operation to return data 10091df013fSAsim Jamshedfrom the beginning of the receive queue without removing 10191df013fSAsim Jamshedthat data from the queue. Thus, a subsequent receive call 10291df013fSAsim Jamshedwill return the same data.</p></td></tr> 10391df013fSAsim Jamshed</table> 10491df013fSAsim Jamshed 10591df013fSAsim Jamshed<h2>RETURN VALUE 10691df013fSAsim Jamshed<a name="RETURN VALUE"></a> 10791df013fSAsim Jamshed</h2> 10891df013fSAsim Jamshed 10991df013fSAsim Jamshed 11091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">On success, the 11191df013fSAsim Jamshednumber of bytes read is returned. It is not an error if this 11291df013fSAsim Jamshednumber is smaller than the number of bytes requested; this 11391df013fSAsim Jamshedmay happen when the socket has fewer number of bytes 11491df013fSAsim Jamshedbuffered at that moment. On all errors, -1 is returned and 11591df013fSAsim Jamshed<i>errno</i> is set appropriately.</p> 11691df013fSAsim Jamshed 11791df013fSAsim Jamshed<h2>ERRORS 11891df013fSAsim Jamshed<a name="ERRORS"></a> 11991df013fSAsim Jamshed</h2> 12091df013fSAsim Jamshed 12191df013fSAsim Jamshed 12291df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void" 12391df013fSAsim Jamshed cellspacing="0" cellpadding="0"> 12491df013fSAsim Jamshed<tr valign="top" align="left"> 12591df013fSAsim Jamshed<td width="11%"></td> 12691df013fSAsim Jamshed<td width="12%"> 12791df013fSAsim Jamshed 12891df013fSAsim Jamshed 12991df013fSAsim Jamshed<p style="margin-top: 1em"><b>EBADF</b></p></td> 13091df013fSAsim Jamshed<td width="3%"></td> 13191df013fSAsim Jamshed<td width="74%"> 13291df013fSAsim Jamshed 13391df013fSAsim Jamshed 13491df013fSAsim Jamshed<p style="margin-top: 1em">The socket descriptor 13591df013fSAsim Jamshed<i>sockid</i> is invalid.</p></td></tr> 13691df013fSAsim Jamshed<tr valign="top" align="left"> 13791df013fSAsim Jamshed<td width="11%"></td> 13891df013fSAsim Jamshed<td width="12%"> 13991df013fSAsim Jamshed 14091df013fSAsim Jamshed 14191df013fSAsim Jamshed<p><b>EINVAL</b></p></td> 14291df013fSAsim Jamshed<td width="3%"></td> 14391df013fSAsim Jamshed<td width="74%"> 14491df013fSAsim Jamshed 14591df013fSAsim Jamshed 14691df013fSAsim Jamshed<p>Invalid argument passed.</p></td></tr> 14791df013fSAsim Jamshed<tr valign="top" align="left"> 14891df013fSAsim Jamshed<td width="11%"></td> 14991df013fSAsim Jamshed<td width="12%"> 15091df013fSAsim Jamshed 15191df013fSAsim Jamshed 15291df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td> 15391df013fSAsim Jamshed<td width="3%"></td> 15491df013fSAsim Jamshed<td width="74%"> 15591df013fSAsim Jamshed 15691df013fSAsim Jamshed 15791df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> has invalid 15891df013fSAsim Jamshed<i>type</i></p> </td></tr> 15991df013fSAsim Jamshed<tr valign="top" align="left"> 16091df013fSAsim Jamshed<td width="11%"></td> 16191df013fSAsim Jamshed<td width="12%"> 16291df013fSAsim Jamshed 16391df013fSAsim Jamshed 16491df013fSAsim Jamshed<p><b>ENOTCONN</b></p></td> 16591df013fSAsim Jamshed<td width="3%"></td> 16691df013fSAsim Jamshed<td width="74%"> 16791df013fSAsim Jamshed 16891df013fSAsim Jamshed 16991df013fSAsim Jamshed<p>Th socket referred to by <i>sockid</i> is in a TCP state 17091df013fSAsim Jamshedthat disallows read operations.</p></td></tr> 17191df013fSAsim Jamshed<tr valign="top" align="left"> 17291df013fSAsim Jamshed<td width="11%"></td> 17391df013fSAsim Jamshed<td width="12%"> 17491df013fSAsim Jamshed 17591df013fSAsim Jamshed 17691df013fSAsim Jamshed<p><b>EAGAIN</b></p></td> 17791df013fSAsim Jamshed<td width="3%"></td> 17891df013fSAsim Jamshed<td width="74%"> 17991df013fSAsim Jamshed 18091df013fSAsim Jamshed 18191df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> does not have 18291df013fSAsim Jamshedany available bytes in its buffer for reading.</p></td></tr> 18391df013fSAsim Jamshed</table> 18491df013fSAsim Jamshed 18591df013fSAsim Jamshed<h2>AUTHORS 18691df013fSAsim Jamshed<a name="AUTHORS"></a> 18791df013fSAsim Jamshed</h2> 18891df013fSAsim Jamshed 18991df013fSAsim Jamshed 190*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS 191*e5df9dc1SAsim Jamsheddevelopment team <[email protected]></p> 19291df013fSAsim Jamshed 19391df013fSAsim Jamshed<h2>SEE ALSO 19491df013fSAsim Jamshed<a name="SEE ALSO"></a> 19591df013fSAsim Jamshed</h2> 19691df013fSAsim Jamshed 19791df013fSAsim Jamshed 19891df013fSAsim Jamshed 19991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(), 20091df013fSAsim Jamshed<b>mtcp_read</b>(), <b>mtcp_accept</b>(), 20191df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_socket</b>(), 20291df013fSAsim Jamshed<b>mtcp_write</b>()</p> 20391df013fSAsim Jamshed 20491df013fSAsim Jamshed<h2>COLOPHON 20591df013fSAsim Jamshed<a name="COLOPHON"></a> 20691df013fSAsim Jamshed</h2> 20791df013fSAsim Jamshed 20891df013fSAsim Jamshed 20991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is 21091df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description 21191df013fSAsim Jamshedof the project, and information about reporting bugs, can be 21291df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p> 213*e5df9dc1SAsim Jamshed<!--<hr>--> 214*e5df9dc1SAsim Jamshed<br> 215*e5df9dc1SAsim Jamshed<div class="footer"> 216*e5df9dc1SAsim Jamshed <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a> 217*e5df9dc1SAsim Jamshed</div> 218*e5df9dc1SAsim Jamshed</div> 21991df013fSAsim Jamshed</body> 22091df013fSAsim Jamshed</html> 221
