191df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
291df013fSAsim Jamshed<!-- CreationDate: Wed Feb 22 20:27:37 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_getconf</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_getconf</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="#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>
33*e5df9dc1SAsim 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_getconf
4191df013fSAsim Jamshed&minus; retrieve the running configuration of mOS
4291df013fSAsim Jamshedapplication</p>
4391df013fSAsim Jamshed
4491df013fSAsim Jamshed<h2>SYNOPSIS
4591df013fSAsim Jamshed<a name="SYNOPSIS"></a>
4691df013fSAsim Jamshed</h2>
4791df013fSAsim Jamshed
4891df013fSAsim Jamshed
4991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
5091df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
5191df013fSAsim Jamshed
5291df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
5391df013fSAsim Jamshedmtcp_getconf(struct mtcp_conf *</b><i>conf</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_getconf</b>()
6291df013fSAsim Jamshedcall is used to fetch the current running configuration of
6391df013fSAsim Jamshedthe mOS core. The <i>conf</i> argument is a pointer to a
6491df013fSAsim Jamsheduser-allocated <i>struct mtcp_conf</i> that contains a
6591df013fSAsim Jamshednumber of fields including:</p>
6691df013fSAsim Jamshed
6791df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
6891df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
6991df013fSAsim Jamshed<tr valign="top" align="left">
7091df013fSAsim Jamshed<td width="11%"></td>
7191df013fSAsim Jamshed<td width="23%">
7291df013fSAsim Jamshed
7391df013fSAsim Jamshed
7491df013fSAsim Jamshed<p><i>num_cores</i></p></td>
7591df013fSAsim Jamshed<td width="8%"></td>
7691df013fSAsim Jamshed<td width="58%">
7791df013fSAsim Jamshed
7891df013fSAsim Jamshed
7991df013fSAsim Jamshed<p>An integer that shows the total number of cores the mOS
8091df013fSAsim Jamshedcore is using.</p></td></tr>
8191df013fSAsim Jamshed<tr valign="top" align="left">
8291df013fSAsim Jamshed<td width="11%"></td>
8391df013fSAsim Jamshed<td width="23%">
8491df013fSAsim Jamshed
8591df013fSAsim Jamshed
8691df013fSAsim Jamshed<p><i>max_concurrency</i></p></td>
8791df013fSAsim Jamshed<td width="8%"></td>
8891df013fSAsim Jamshed<td width="58%">
8991df013fSAsim Jamshed
9091df013fSAsim Jamshed
9191df013fSAsim Jamshed<p>An integer that holds how many ongoing flows each core
9291df013fSAsim Jamshedthread manages concurrently. Default value is 100000.</p></td></tr>
9391df013fSAsim Jamshed<tr valign="top" align="left">
9491df013fSAsim Jamshed<td width="11%"></td>
9591df013fSAsim Jamshed<td width="23%">
9691df013fSAsim Jamshed
9791df013fSAsim Jamshed
9891df013fSAsim Jamshed<p><i>max_num_buffers</i></p></td>
9991df013fSAsim Jamshed<td width="8%"></td>
10091df013fSAsim Jamshed<td width="58%">
10191df013fSAsim Jamshed
10291df013fSAsim Jamshed
10391df013fSAsim Jamshed<p>An integer that holds the maximum number of socket
10491df013fSAsim Jamshedbuffers each core thread can hold. Default value is
10591df013fSAsim Jamshed100000.</p> </td></tr>
10691df013fSAsim Jamshed<tr valign="top" align="left">
10791df013fSAsim Jamshed<td width="11%"></td>
10891df013fSAsim Jamshed<td width="23%">
10991df013fSAsim Jamshed
11091df013fSAsim Jamshed
11191df013fSAsim Jamshed<p><i>rcvbuf_size</i></p></td>
11291df013fSAsim Jamshed<td width="8%"></td>
11391df013fSAsim Jamshed<td width="58%">
11491df013fSAsim Jamshed
11591df013fSAsim Jamshed
11691df013fSAsim Jamshed<p>An integer that holds the size of the TCP receive
11791df013fSAsim Jamshedbuffer. Default value is 8KB.</p></td></tr>
11891df013fSAsim Jamshed<tr valign="top" align="left">
11991df013fSAsim Jamshed<td width="11%"></td>
12091df013fSAsim Jamshed<td width="23%">
12191df013fSAsim Jamshed
12291df013fSAsim Jamshed
12391df013fSAsim Jamshed<p><i>tcp_timeout</i></p></td>
12491df013fSAsim Jamshed<td width="8%"></td>
12591df013fSAsim Jamshed<td width="58%">
12691df013fSAsim Jamshed
12791df013fSAsim Jamshed
12891df013fSAsim Jamshed<p>An integer that holds the idle flow expiry timeout of
12991df013fSAsim Jamshedthe monitoring flow. Default value is 30 secs.</p></td></tr>
13091df013fSAsim Jamshed</table>
13191df013fSAsim Jamshed
13291df013fSAsim Jamshed<h2>RETURN VALUE
13391df013fSAsim Jamshed<a name="RETURN VALUE"></a>
13491df013fSAsim Jamshed</h2>
13591df013fSAsim Jamshed
13691df013fSAsim Jamshed
13791df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
13891df013fSAsim Jamshedsuccess; -1 on failure and <i>errno</i> is set
13991df013fSAsim Jamshedappropriately.</p>
14091df013fSAsim Jamshed
14191df013fSAsim Jamshed<h2>ERRORS
14291df013fSAsim Jamshed<a name="ERRORS"></a>
14391df013fSAsim Jamshed</h2>
14491df013fSAsim Jamshed
14591df013fSAsim Jamshed
14691df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
14791df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
14891df013fSAsim Jamshed<tr valign="top" align="left">
14991df013fSAsim Jamshed<td width="11%"></td>
15091df013fSAsim Jamshed<td width="9%">
15191df013fSAsim Jamshed
15291df013fSAsim Jamshed
15391df013fSAsim Jamshed<p style="margin-top: 1em"><b>EINVAL</b></p></td>
15491df013fSAsim Jamshed<td width="6%"></td>
15591df013fSAsim Jamshed<td width="40%">
15691df013fSAsim Jamshed
15791df013fSAsim Jamshed
15891df013fSAsim Jamshed<p style="margin-top: 1em">The <i>conf</i> argument is
15991df013fSAsim JamshedNULL.</p> </td>
16091df013fSAsim Jamshed<td width="34%">
16191df013fSAsim Jamshed</td></tr>
16291df013fSAsim Jamshed</table>
16391df013fSAsim Jamshed
16491df013fSAsim Jamshed<h2>NOTES
16591df013fSAsim Jamshed<a name="NOTES"></a>
16691df013fSAsim Jamshed</h2>
16791df013fSAsim Jamshed
16891df013fSAsim Jamshed
16991df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">See
17091df013fSAsim Jamshed<i>http://mos.kaist.edu/guide/walkthrough/05_configuration.html</i>
17191df013fSAsim Jamshedto view example startup mOS configuration file.</p>
17291df013fSAsim Jamshed
17391df013fSAsim Jamshed<h2>AUTHORS
17491df013fSAsim Jamshed<a name="AUTHORS"></a>
17591df013fSAsim Jamshed</h2>
17691df013fSAsim Jamshed
17791df013fSAsim Jamshed
17891df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
17991df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
18091df013fSAsim Jamshed
181*e5df9dc1SAsim Jamshed<!----------------------------------------------------------->
182*e5df9dc1SAsim Jamshed<h2>EXAMPLES
183*e5df9dc1SAsim Jamshed<a name="EXAMPLES"></a>
184*e5df9dc1SAsim Jamshed</h2>
185*e5df9dc1SAsim Jamshed
186*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">
187*e5df9dc1SAsim Jamshed  <a href="http://mos.kaist.edu/guide/programmer/05_api_example.html#global-initialization-routine">
188*e5df9dc1SAsim Jamshed	http://mos.kaist.edu/guide/programmer/05_api_example.html#global-initialization-routine
189*e5df9dc1SAsim Jamshed	</a>
190*e5df9dc1SAsim Jamshed</p>
191*e5df9dc1SAsim Jamshed<!----------------------------------------------------------->
192*e5df9dc1SAsim 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_setconf</b>()</p>
20091df013fSAsim Jamshed
20191df013fSAsim Jamshed<h2>COLOPHON
20291df013fSAsim Jamshed<a name="COLOPHON"></a>
20391df013fSAsim Jamshed</h2>
20491df013fSAsim Jamshed
20591df013fSAsim Jamshed
20691df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
20791df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
20891df013fSAsim Jamshedof the project, and information about reporting bugs, can be
20991df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
210*e5df9dc1SAsim Jamshed<!-- <hr> -->
211*e5df9dc1SAsim Jamshed<br>
212*e5df9dc1SAsim Jamshed<div class="footer">
213*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
214*e5df9dc1SAsim Jamshed</div>
215*e5df9dc1SAsim Jamshed</div>
21691df013fSAsim Jamshed</body>
21791df013fSAsim Jamshed</html>
218