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_write</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_write</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_write
41*91df013fSAsim Jamshed&minus; send bytestream to 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>ssize_t
52*91df013fSAsim Jamshedmtcp_write(mctx_t</b> <i>mctx</i><b>, int</b>
53*91df013fSAsim Jamshed<i>sockid</i><b>, char *</b><i>buf</i><b>, size_t</b>
54*91df013fSAsim Jamshed<i>len</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_write</b>()
63*91df013fSAsim Jamshedsends up to <i>len</i> number of bytes from the buffer that
64*91df013fSAsim Jamshedis being pointed by <i>buf.</i> The bytestream is sent to
65*91df013fSAsim Jamshedthe mTCP socket using the <i>sockid</i> descriptor.</p>
66*91df013fSAsim Jamshed
67*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">An
68*91df013fSAsim Jamshed<b>mtcp_write()</b> function call may write less number of
69*91df013fSAsim Jamshedbytes than <i>len</i> if there is insufficient space in the
70*91df013fSAsim Jamshedwrite buffer of the socket. In such a case, the return value
71*91df013fSAsim Jamshedis considered the actual number of bytes successfully
72*91df013fSAsim Jamshedwritten.</p>
73*91df013fSAsim Jamshed
74*91df013fSAsim Jamshed
75*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_write</b>()
76*91df013fSAsim Jamshedcall takes an additional argument named <i>mctx</i> that
77*91df013fSAsim Jamshedrepresents the per-core mTCP context in an application (see
78*91df013fSAsim Jamshed<b>mtcp_create_context()</b> for details).</p>
79*91df013fSAsim Jamshed
80*91df013fSAsim Jamshed<h2>RETURN VALUE
81*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
82*91df013fSAsim Jamshed</h2>
83*91df013fSAsim Jamshed
84*91df013fSAsim Jamshed
85*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">On success, the
86*91df013fSAsim Jamshednumber of bytes dispatched via the socket are returned. The
87*91df013fSAsim Jamshednumber of bytes sent can be less than <i>count</i> if there
88*91df013fSAsim Jamshedis insufficient space in the write buffer of the socket. On
89*91df013fSAsim Jamshederror, -1 is returned and <i>errno</i> is set
90*91df013fSAsim Jamshedappropriately.</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="12%">
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed
104*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EAGAIN</b></p></td>
105*91df013fSAsim Jamshed<td width="3%"></td>
106*91df013fSAsim Jamshed<td width="74%">
107*91df013fSAsim Jamshed
108*91df013fSAsim Jamshed
109*91df013fSAsim Jamshed<p style="margin-top: 1em">The write buffer of the socket
110*91df013fSAsim Jamshedis currently full. The user should call the write function
111*91df013fSAsim Jamshedagain once the write buffer has space available.</p></td></tr>
112*91df013fSAsim Jamshed<tr valign="top" align="left">
113*91df013fSAsim Jamshed<td width="11%"></td>
114*91df013fSAsim Jamshed<td width="12%">
115*91df013fSAsim Jamshed
116*91df013fSAsim Jamshed
117*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
118*91df013fSAsim Jamshed<td width="3%"></td>
119*91df013fSAsim Jamshed<td width="74%">
120*91df013fSAsim Jamshed
121*91df013fSAsim Jamshed
122*91df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
123*91df013fSAsim Jamshedwriting.</p> </td></tr>
124*91df013fSAsim Jamshed<tr valign="top" align="left">
125*91df013fSAsim Jamshed<td width="11%"></td>
126*91df013fSAsim Jamshed<td width="12%">
127*91df013fSAsim Jamshed
128*91df013fSAsim Jamshed
129*91df013fSAsim Jamshed<p><b>ENOTCONN</b></p></td>
130*91df013fSAsim Jamshed<td width="3%"></td>
131*91df013fSAsim Jamshed<td width="74%">
132*91df013fSAsim Jamshed
133*91df013fSAsim Jamshed
134*91df013fSAsim Jamshed<p>The underlying connection is not in a TCP state that
135*91df013fSAsim Jamshedallows data transmission (i.e. the TCP flow is neither in
136*91df013fSAsim Jamshed<b>ESTABLISHED</b> or <b>CLOSE_WAIT</b> state).</p></td></tr>
137*91df013fSAsim Jamshed<tr valign="top" align="left">
138*91df013fSAsim Jamshed<td width="11%"></td>
139*91df013fSAsim Jamshed<td width="12%">
140*91df013fSAsim Jamshed
141*91df013fSAsim Jamshed
142*91df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
143*91df013fSAsim Jamshed<td width="3%"></td>
144*91df013fSAsim Jamshed<td width="74%">
145*91df013fSAsim Jamshed
146*91df013fSAsim Jamshed
147*91df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> is not
148*91df013fSAsim Jamshedvalid.</p> </td></tr>
149*91df013fSAsim Jamshed</table>
150*91df013fSAsim Jamshed
151*91df013fSAsim Jamshed<h2>AUTHORS
152*91df013fSAsim Jamshed<a name="AUTHORS"></a>
153*91df013fSAsim Jamshed</h2>
154*91df013fSAsim Jamshed
155*91df013fSAsim Jamshed
156*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
157*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
158*91df013fSAsim Jamshed
159*91df013fSAsim Jamshed<h2>SEE ALSO
160*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
161*91df013fSAsim Jamshed</h2>
162*91df013fSAsim Jamshed
163*91df013fSAsim Jamshed
164*91df013fSAsim Jamshed
165*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_bind</b>(),
166*91df013fSAsim Jamshed<b>mtcp_listen</b>(), <b>mtcp_accept</b>(),
167*91df013fSAsim Jamshed<b>mtcp_connect</b>(), <b>mtcp_read</b>(),
168*91df013fSAsim Jamshed<b>mtcp_socket</b>()</p>
169*91df013fSAsim Jamshed
170*91df013fSAsim Jamshed<h2>COLOPHON
171*91df013fSAsim Jamshed<a name="COLOPHON"></a>
172*91df013fSAsim Jamshed</h2>
173*91df013fSAsim Jamshed
174*91df013fSAsim Jamshed
175*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
176*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
177*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
178*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
179*91df013fSAsim Jamshed<hr>
180*91df013fSAsim Jamshed</body>
181*91df013fSAsim Jamshed</html>
182