1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Thu Feb  2 01:55:58 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_close</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_close</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="#NOTES">NOTES</a><br>
29*91df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
30*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
31*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
32*91df013fSAsim Jamshed
33*91df013fSAsim Jamshed<hr>
34*91df013fSAsim Jamshed
35*91df013fSAsim Jamshed
36*91df013fSAsim Jamshed<h2>NAME
37*91df013fSAsim Jamshed<a name="NAME"></a>
38*91df013fSAsim Jamshed</h2>
39*91df013fSAsim Jamshed
40*91df013fSAsim Jamshed
41*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_close
42*91df013fSAsim Jamshed&minus; close an mTCP socket descriptor</p>
43*91df013fSAsim Jamshed
44*91df013fSAsim Jamshed<h2>SYNOPSIS
45*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
46*91df013fSAsim Jamshed</h2>
47*91df013fSAsim Jamshed
48*91df013fSAsim Jamshed
49*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
50*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
51*91df013fSAsim Jamshed
52*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
53*91df013fSAsim Jamshedmtcp_close(mctx_t</b> <i>mctx</i><b>, int</b>
54*91df013fSAsim Jamshed<i>sockid</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_close</b>()
63*91df013fSAsim Jamshedcloses the socket associated with <i>sockid</i> descriptor.
64*91df013fSAsim JamshedThis call can be used to gracefully terminate the underlying
65*91df013fSAsim Jamshedconnection for active endpoint (SOCK_STREAM) sockets. All
66*91df013fSAsim Jamshedthe underlying resources pertaining to the connection are
67*91df013fSAsim Jamshedalso destroyed. <b>mtcp_close()</b> can also be used to shut
68*91df013fSAsim Jamsheddown a passive listening socket. For monitoring socket types
69*91df013fSAsim Jamshed(MOS_SOCK_MONITOR_STREAM and MOS_SOCKET_MONITOR_RAW), all
70*91df013fSAsim Jamshedflow events are deregistered from the socket.</p>
71*91df013fSAsim Jamshed
72*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">In all cases,
73*91df013fSAsim Jamshedthe socket ID is made available for re-use for a future
74*91df013fSAsim Jamshedincoming connection request.</p>
75*91df013fSAsim Jamshed
76*91df013fSAsim Jamshed
77*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_close</b>()
78*91df013fSAsim Jamshedcall takes an additional argument named <i>mctx</i> that
79*91df013fSAsim Jamshedrepresents the per-core mTCP context in an application (see
80*91df013fSAsim Jamshed<b>mtcp_create_context()</b> for details).</p>
81*91df013fSAsim Jamshed
82*91df013fSAsim Jamshed<h2>RETURN VALUE
83*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
84*91df013fSAsim Jamshed</h2>
85*91df013fSAsim Jamshed
86*91df013fSAsim Jamshed
87*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
88*91df013fSAsim Jamshedsuccess; -1 on failure and <i>errno</i> is set
89*91df013fSAsim Jamshedappropriately.</p>
90*91df013fSAsim Jamshed
91*91df013fSAsim Jamshed<h2>ERRORS
92*91df013fSAsim Jamshed<a name="ERRORS"></a>
93*91df013fSAsim Jamshed</h2>
94*91df013fSAsim Jamshed
95*91df013fSAsim Jamshed
96*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
97*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
98*91df013fSAsim Jamshed<tr valign="top" align="left">
99*91df013fSAsim Jamshed<td width="11%"></td>
100*91df013fSAsim Jamshed<td width="12%">
101*91df013fSAsim Jamshed
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td>
104*91df013fSAsim Jamshed<td width="3%"></td>
105*91df013fSAsim Jamshed<td width="74%">
106*91df013fSAsim Jamshed
107*91df013fSAsim Jamshed
108*91df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is not valid.</p></td></tr>
109*91df013fSAsim Jamshed<tr valign="top" align="left">
110*91df013fSAsim Jamshed<td width="11%"></td>
111*91df013fSAsim Jamshed<td width="12%">
112*91df013fSAsim Jamshed
113*91df013fSAsim Jamshed
114*91df013fSAsim Jamshed<p><b>EAGAIN</b></p></td>
115*91df013fSAsim Jamshed<td width="3%"></td>
116*91df013fSAsim Jamshed<td width="74%">
117*91df013fSAsim Jamshed
118*91df013fSAsim Jamshed
119*91df013fSAsim Jamshed<p>The request to close the connection was refused.</p></td></tr>
120*91df013fSAsim Jamshed<tr valign="top" align="left">
121*91df013fSAsim Jamshed<td width="11%"></td>
122*91df013fSAsim Jamshed<td width="12%">
123*91df013fSAsim Jamshed
124*91df013fSAsim Jamshed
125*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
126*91df013fSAsim Jamshed<td width="3%"></td>
127*91df013fSAsim Jamshed<td width="74%">
128*91df013fSAsim Jamshed
129*91df013fSAsim Jamshed
130*91df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
131*91df013fSAsim Jamshedclosing.</p> </td></tr>
132*91df013fSAsim Jamshed<tr valign="top" align="left">
133*91df013fSAsim Jamshed<td width="11%"></td>
134*91df013fSAsim Jamshed<td width="12%">
135*91df013fSAsim Jamshed
136*91df013fSAsim Jamshed
137*91df013fSAsim Jamshed<p><b>EINVAL</b></p></td>
138*91df013fSAsim Jamshed<td width="3%"></td>
139*91df013fSAsim Jamshed<td width="74%">
140*91df013fSAsim Jamshed
141*91df013fSAsim Jamshed
142*91df013fSAsim Jamshed<p>The socket specific to <i>sockid</i> has invalid
143*91df013fSAsim Jamshedtype.</p> </td></tr>
144*91df013fSAsim Jamshed<tr valign="top" align="left">
145*91df013fSAsim Jamshed<td width="11%"></td>
146*91df013fSAsim Jamshed<td width="12%">
147*91df013fSAsim Jamshed
148*91df013fSAsim Jamshed
149*91df013fSAsim Jamshed<p><b>ENOTCONN</b></p></td>
150*91df013fSAsim Jamshed<td width="3%"></td>
151*91df013fSAsim Jamshed<td width="74%">
152*91df013fSAsim Jamshed
153*91df013fSAsim Jamshed
154*91df013fSAsim Jamshed<p>The connection referred to by <i>sockid</i> is already
155*91df013fSAsim Jamshedterminated.</p> </td></tr>
156*91df013fSAsim Jamshed<tr valign="top" align="left">
157*91df013fSAsim Jamshed<td width="11%"></td>
158*91df013fSAsim Jamshed<td width="12%">
159*91df013fSAsim Jamshed
160*91df013fSAsim Jamshed
161*91df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td>
162*91df013fSAsim Jamshed<td width="3%"></td>
163*91df013fSAsim Jamshed<td width="74%">
164*91df013fSAsim Jamshed
165*91df013fSAsim Jamshed
166*91df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> is not
167*91df013fSAsim Jamshedvalid.</p> </td></tr>
168*91df013fSAsim Jamshed</table>
169*91df013fSAsim Jamshed
170*91df013fSAsim Jamshed<h2>NOTES
171*91df013fSAsim Jamshed<a name="NOTES"></a>
172*91df013fSAsim Jamshed</h2>
173*91df013fSAsim Jamshed
174*91df013fSAsim Jamshed
175*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Please note
176*91df013fSAsim Jamshedthat the same <i>mctx</i> context should be used to destroy
177*91df013fSAsim Jamshedthe socket that created the socket via <b>mtcp_socket ()</b>
178*91df013fSAsim Jamshedcall in the first place. The user may experience
179*91df013fSAsim Jamshedunpredictable behavior if this practice is not followed.</p>
180*91df013fSAsim Jamshed
181*91df013fSAsim Jamshed<h2>AUTHORS
182*91df013fSAsim Jamshed<a name="AUTHORS"></a>
183*91df013fSAsim Jamshed</h2>
184*91df013fSAsim Jamshed
185*91df013fSAsim Jamshed
186*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
187*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
188*91df013fSAsim Jamshed
189*91df013fSAsim Jamshed<h2>SEE ALSO
190*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
191*91df013fSAsim Jamshed</h2>
192*91df013fSAsim Jamshed
193*91df013fSAsim Jamshed
194*91df013fSAsim Jamshed
195*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_socket</b>()</p>
196*91df013fSAsim Jamshed
197*91df013fSAsim Jamshed<h2>COLOPHON
198*91df013fSAsim Jamshed<a name="COLOPHON"></a>
199*91df013fSAsim Jamshed</h2>
200*91df013fSAsim Jamshed
201*91df013fSAsim Jamshed
202*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
203*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
204*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
205*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
206*91df013fSAsim Jamshed<hr>
207*91df013fSAsim Jamshed</body>
208*91df013fSAsim Jamshed</html>
209