191df013fSAsim Jamshed<!-- Creator : groff version 1.22.2 --> 291df013fSAsim Jamshed<!-- CreationDate: Sun Feb 5 16:09:43 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_settimer</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_settimer</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="#AUTHORS">AUTHORS</a><br> 2891df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br> 2991df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br> 3091df013fSAsim Jamshed<hr> 31*e5df9dc1SAsim Jamshed--> 3291df013fSAsim Jamshed 3391df013fSAsim Jamshed<h2>NAME 3491df013fSAsim Jamshed<a name="NAME"></a> 3591df013fSAsim Jamshed</h2> 3691df013fSAsim Jamshed 3791df013fSAsim Jamshed 3891df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_settimer 3991df013fSAsim Jamshed− register user’s timer-based callback 4091df013fSAsim Jamshedhandler</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<mos_api.h></b></p> 4991df013fSAsim Jamshed 5091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int 5191df013fSAsim Jamshedmtcp_settimer(mctx_t</b> <i>mctx</i><b>, int</b> 5291df013fSAsim Jamshed<i>id</i><b>, struct timeval *</b><i>timeout</i><b>, 5391df013fSAsim Jamshedcallback_t</b> <i>cb</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_settimer</b>() 6291df013fSAsim Jamshedcan be used to register callback handler function, <i>cb 6391df013fSAsim Jamshed,</i> that is invoked after a time interval of 6491df013fSAsim Jamshed<i>timeout</i> microseconds. Note that this callback is a 6591df013fSAsim Jamshedone time registration and <i>cb</i> (see 6691df013fSAsim Jamshed<b>mtcp_register_callback</b>() for definition) is called 6791df013fSAsim Jamshedonly once when <i>timeout</i> period expires. The <i>id</i> 6891df013fSAsim Jamshedargument is a unique identifier that is passed to <i>cb</i> 6991df013fSAsim Jamshedas one of the function arguments.</p> 7091df013fSAsim Jamshed 7191df013fSAsim Jamshed 7291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_settimer</b>() 7391df013fSAsim Jamshedcall takes an additional argument named <i>mctx</i> that 7491df013fSAsim Jamshedrepresents the per-core mTCP context in an application (see 7591df013fSAsim Jamshed<b>mtcp_create_context()</b> for details).</p> 7691df013fSAsim Jamshed 7791df013fSAsim Jamshed<h2>RETURN VALUE 7891df013fSAsim Jamshed<a name="RETURN VALUE"></a> 7991df013fSAsim Jamshed</h2> 8091df013fSAsim Jamshed 8191df013fSAsim Jamshed 8291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">On success 0 is 8391df013fSAsim Jamshedreturned; -1 on failure.</p> 8491df013fSAsim Jamshed 8591df013fSAsim Jamshed<h2>AUTHORS 8691df013fSAsim Jamshed<a name="AUTHORS"></a> 8791df013fSAsim Jamshed</h2> 8891df013fSAsim Jamshed 8991df013fSAsim Jamshed 9091df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development 9191df013fSAsim Jamshedteam <[email protected]></p> 9291df013fSAsim Jamshed 93*e5df9dc1SAsim Jamshed<!-----------------------------------------------------------> 94*e5df9dc1SAsim Jamshed<h2>EXAMPLES 95*e5df9dc1SAsim Jamshed<a name="EXAMPLES"></a> 96*e5df9dc1SAsim Jamshed</h2> 97*e5df9dc1SAsim Jamshed 98*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"> 99*e5df9dc1SAsim Jamshed <a href="http://mos.kaist.edu/guide/programmer/05_api_example.html#registering-for-timer-events"> 100*e5df9dc1SAsim Jamshed http://mos.kaist.edu/guide/programmer/05_api_example.html#registering-for-timer-events 101*e5df9dc1SAsim Jamshed </a> 102*e5df9dc1SAsim Jamshed</p> 103*e5df9dc1SAsim Jamshed<!-----------------------------------------------------------> 104*e5df9dc1SAsim Jamshed 10591df013fSAsim Jamshed<h2>SEE ALSO 10691df013fSAsim Jamshed<a name="SEE ALSO"></a> 10791df013fSAsim Jamshed</h2> 10891df013fSAsim Jamshed 10991df013fSAsim Jamshed 11091df013fSAsim Jamshed 11191df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_register_callback</b>(), 11291df013fSAsim Jamshed<b>mtcp_socket</b>(),</p> 11391df013fSAsim Jamshed 11491df013fSAsim Jamshed<h2>COLOPHON 11591df013fSAsim Jamshed<a name="COLOPHON"></a> 11691df013fSAsim Jamshed</h2> 11791df013fSAsim Jamshed 11891df013fSAsim Jamshed 11991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is 12091df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description 12191df013fSAsim Jamshedof the project, and information about reporting bugs, can be 12291df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p> 123*e5df9dc1SAsim Jamshed<!-- <hr> --> 124*e5df9dc1SAsim Jamshed<br> 125*e5df9dc1SAsim Jamshed<div class="footer"> 126*e5df9dc1SAsim Jamshed <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a> 127*e5df9dc1SAsim Jamshed</div> 128*e5df9dc1SAsim Jamshed</div> 12991df013fSAsim Jamshed</body> 13091df013fSAsim Jamshed</html> 131
