191df013fSAsim Jamshed<!-- Creator : groff version 1.22.2 --> 291df013fSAsim Jamshed<!-- CreationDate: Thu Feb 2 01:55:58 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_close</title> 17e5df9dc1SAsim Jamshed<link rel="stylesheet" href="./common.css"> 1891df013fSAsim Jamshed</head> 1991df013fSAsim Jamshed<body> 20e5df9dc1SAsim Jamshed<div class="main"> 2191df013fSAsim Jamshed<h1 align="center">mtcp_close</h1> 22e5df9dc1SAsim 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="#NOTES">NOTES</a><br> 2991df013fSAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br> 3091df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br> 3191df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br> 3291df013fSAsim Jamshed<hr> 33e5df9dc1SAsim Jamshed--> 3491df013fSAsim Jamshed 3591df013fSAsim Jamshed<h2>NAME 3691df013fSAsim Jamshed<a name="NAME"></a> 3791df013fSAsim Jamshed</h2> 3891df013fSAsim Jamshed 3991df013fSAsim Jamshed 4091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_close 4191df013fSAsim Jamshed− close an mTCP socket descriptor</p> 4291df013fSAsim Jamshed 4391df013fSAsim Jamshed<h2>SYNOPSIS 4491df013fSAsim Jamshed<a name="SYNOPSIS"></a> 4591df013fSAsim Jamshed</h2> 4691df013fSAsim Jamshed 4791df013fSAsim Jamshed 4891df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include 4991df013fSAsim Jamshed<mtcp_api.h></b></p> 5091df013fSAsim Jamshed 5191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int 5291df013fSAsim Jamshedmtcp_close(mctx_t</b> <i>mctx</i><b>, int</b> 5391df013fSAsim Jamshed<i>sockid</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_close</b>() 6291df013fSAsim Jamshedcloses the socket associated with <i>sockid</i> descriptor. 6391df013fSAsim JamshedThis call can be used to gracefully terminate the underlying 6491df013fSAsim Jamshedconnection for active endpoint (SOCK_STREAM) sockets. All 6591df013fSAsim Jamshedthe underlying resources pertaining to the connection are 6691df013fSAsim Jamshedalso destroyed. <b>mtcp_close()</b> can also be used to shut 6791df013fSAsim Jamsheddown a passive listening socket. For monitoring socket types 6891df013fSAsim Jamshed(MOS_SOCK_MONITOR_STREAM and MOS_SOCKET_MONITOR_RAW), all 6991df013fSAsim Jamshedflow events are deregistered from the socket.</p> 7091df013fSAsim Jamshed 7191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">In all cases, 7291df013fSAsim Jamshedthe socket ID is made available for re-use for a future 7391df013fSAsim Jamshedincoming connection request.</p> 7491df013fSAsim Jamshed 7591df013fSAsim Jamshed 7691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_close</b>() 7791df013fSAsim Jamshedcall takes an additional argument named <i>mctx</i> that 7891df013fSAsim Jamshedrepresents the per-core mTCP context in an application (see 7991df013fSAsim Jamshed<b>mtcp_create_context()</b> for details).</p> 8091df013fSAsim Jamshed 8191df013fSAsim Jamshed<h2>RETURN VALUE 8291df013fSAsim Jamshed<a name="RETURN VALUE"></a> 8391df013fSAsim Jamshed</h2> 8491df013fSAsim Jamshed 8591df013fSAsim Jamshed 8691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on 8791df013fSAsim Jamshedsuccess; -1 on failure and <i>errno</i> is set 8891df013fSAsim Jamshedappropriately.</p> 8991df013fSAsim Jamshed 9091df013fSAsim Jamshed<h2>ERRORS 9191df013fSAsim Jamshed<a name="ERRORS"></a> 9291df013fSAsim Jamshed</h2> 9391df013fSAsim Jamshed 9491df013fSAsim Jamshed 9591df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void" 9691df013fSAsim Jamshed cellspacing="0" cellpadding="0"> 9791df013fSAsim Jamshed<tr valign="top" align="left"> 9891df013fSAsim Jamshed<td width="11%"></td> 9991df013fSAsim Jamshed<td width="12%"> 10091df013fSAsim Jamshed 10191df013fSAsim Jamshed 10291df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td> 10391df013fSAsim Jamshed<td width="3%"></td> 10491df013fSAsim Jamshed<td width="74%"> 10591df013fSAsim Jamshed 10691df013fSAsim Jamshed 10791df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is not valid.</p></td></tr> 10891df013fSAsim Jamshed<tr valign="top" align="left"> 10991df013fSAsim Jamshed<td width="11%"></td> 11091df013fSAsim Jamshed<td width="12%"> 11191df013fSAsim Jamshed 11291df013fSAsim Jamshed 11391df013fSAsim Jamshed<p><b>EAGAIN</b></p></td> 11491df013fSAsim Jamshed<td width="3%"></td> 11591df013fSAsim Jamshed<td width="74%"> 11691df013fSAsim Jamshed 11791df013fSAsim Jamshed 11891df013fSAsim Jamshed<p>The request to close the connection was refused.</p></td></tr> 11991df013fSAsim Jamshed<tr valign="top" align="left"> 12091df013fSAsim Jamshed<td width="11%"></td> 12191df013fSAsim Jamshed<td width="12%"> 12291df013fSAsim Jamshed 12391df013fSAsim Jamshed 12491df013fSAsim Jamshed<p><b>EBADF</b></p></td> 12591df013fSAsim Jamshed<td width="3%"></td> 12691df013fSAsim Jamshed<td width="74%"> 12791df013fSAsim Jamshed 12891df013fSAsim Jamshed 12991df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for 13091df013fSAsim Jamshedclosing.</p> </td></tr> 13191df013fSAsim Jamshed<tr valign="top" align="left"> 13291df013fSAsim Jamshed<td width="11%"></td> 13391df013fSAsim Jamshed<td width="12%"> 13491df013fSAsim Jamshed 13591df013fSAsim Jamshed 13691df013fSAsim Jamshed<p><b>EINVAL</b></p></td> 13791df013fSAsim Jamshed<td width="3%"></td> 13891df013fSAsim Jamshed<td width="74%"> 13991df013fSAsim Jamshed 14091df013fSAsim Jamshed 14191df013fSAsim Jamshed<p>The socket specific to <i>sockid</i> has invalid 14291df013fSAsim Jamshedtype.</p> </td></tr> 14391df013fSAsim Jamshed<tr valign="top" align="left"> 14491df013fSAsim Jamshed<td width="11%"></td> 14591df013fSAsim Jamshed<td width="12%"> 14691df013fSAsim Jamshed 14791df013fSAsim Jamshed 14891df013fSAsim Jamshed<p><b>ENOTCONN</b></p></td> 14991df013fSAsim Jamshed<td width="3%"></td> 15091df013fSAsim Jamshed<td width="74%"> 15191df013fSAsim Jamshed 15291df013fSAsim Jamshed 15391df013fSAsim Jamshed<p>The connection referred to by <i>sockid</i> is already 15491df013fSAsim Jamshedterminated.</p> </td></tr> 15591df013fSAsim Jamshed<tr valign="top" align="left"> 15691df013fSAsim Jamshed<td width="11%"></td> 15791df013fSAsim Jamshed<td width="12%"> 15891df013fSAsim Jamshed 15991df013fSAsim Jamshed 16091df013fSAsim Jamshed<p><b>ENOTSOCK</b></p></td> 16191df013fSAsim Jamshed<td width="3%"></td> 16291df013fSAsim Jamshed<td width="74%"> 16391df013fSAsim Jamshed 16491df013fSAsim Jamshed 16591df013fSAsim Jamshed<p>The socket referred to by <i>sockid</i> is not 16691df013fSAsim Jamshedvalid.</p> </td></tr> 16791df013fSAsim Jamshed</table> 16891df013fSAsim Jamshed 16991df013fSAsim Jamshed<h2>NOTES 17091df013fSAsim Jamshed<a name="NOTES"></a> 17191df013fSAsim Jamshed</h2> 17291df013fSAsim Jamshed 17391df013fSAsim Jamshed 17491df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Please note 17591df013fSAsim Jamshedthat the same <i>mctx</i> context should be used to destroy 17691df013fSAsim Jamshedthe socket that created the socket via <b>mtcp_socket ()</b> 17791df013fSAsim Jamshedcall in the first place. The user may experience 17891df013fSAsim Jamshedunpredictable behavior if this practice is not followed.</p> 17991df013fSAsim Jamshed 18091df013fSAsim Jamshed<h2>AUTHORS 18191df013fSAsim Jamshed<a name="AUTHORS"></a> 18291df013fSAsim Jamshed</h2> 18391df013fSAsim Jamshed 18491df013fSAsim Jamshed 18591df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development 18691df013fSAsim Jamshedteam <[email protected]></p> 18791df013fSAsim Jamshed 188*626fc701SYoungGyoun<!-----------------------------------------------------------> 189*626fc701SYoungGyoun<h2>EXAMPLES 190*626fc701SYoungGyoun<a name="EXAMPLES"></a> 191*626fc701SYoungGyoun</h2> 192*626fc701SYoungGyoun 193*626fc701SYoungGyoun<p style="margin-left:11%; margin-top: 1em"> 194*626fc701SYoungGyoun <a href="http://mos.kaist.edu/guide/programmer/05_api_example.html#application-destroy-routine"> 195*626fc701SYoungGyoun http://mos.kaist.edu/guide/programmer/05_api_example.html#application-destroy-routine 196*626fc701SYoungGyoun </a> 197*626fc701SYoungGyoun</p> 198*626fc701SYoungGyoun<!-----------------------------------------------------------> 199*626fc701SYoungGyoun 20091df013fSAsim Jamshed<h2>SEE ALSO 20191df013fSAsim Jamshed<a name="SEE ALSO"></a> 20291df013fSAsim Jamshed</h2> 20391df013fSAsim Jamshed 20491df013fSAsim Jamshed 20591df013fSAsim Jamshed 20691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_socket</b>()</p> 20791df013fSAsim Jamshed 20891df013fSAsim Jamshed<h2>COLOPHON 20991df013fSAsim Jamshed<a name="COLOPHON"></a> 21091df013fSAsim Jamshed</h2> 21191df013fSAsim Jamshed 21291df013fSAsim Jamshed 21391df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is 21491df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description 21591df013fSAsim Jamshedof the project, and information about reporting bugs, can be 21691df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p> 217e5df9dc1SAsim Jamshed<!--<hr>--> 218e5df9dc1SAsim Jamshed<br> 219e5df9dc1SAsim Jamshed<div class="footer"> 220e5df9dc1SAsim Jamshed <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a> 221e5df9dc1SAsim Jamshed</div> 222e5df9dc1SAsim Jamshed</div> 22391df013fSAsim Jamshed</body> 22491df013fSAsim Jamshed</html> 225
