1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Wed Feb 22 20:27:37 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_getconf</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_getconf</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_getconf
42*91df013fSAsim Jamshed&minus; retrieve the running configuration of mOS
43*91df013fSAsim Jamshedapplication</p>
44*91df013fSAsim Jamshed
45*91df013fSAsim Jamshed<h2>SYNOPSIS
46*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
47*91df013fSAsim Jamshed</h2>
48*91df013fSAsim Jamshed
49*91df013fSAsim Jamshed
50*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
51*91df013fSAsim Jamshed&lt;mtcp_api.h&gt;</b></p>
52*91df013fSAsim Jamshed
53*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
54*91df013fSAsim Jamshedmtcp_getconf(struct mtcp_conf *</b><i>conf</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_getconf</b>()
63*91df013fSAsim Jamshedcall is used to fetch the current running configuration of
64*91df013fSAsim Jamshedthe mOS core. The <i>conf</i> argument is a pointer to a
65*91df013fSAsim Jamsheduser-allocated <i>struct mtcp_conf</i> that contains a
66*91df013fSAsim Jamshednumber of fields including:</p>
67*91df013fSAsim Jamshed
68*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
69*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
70*91df013fSAsim Jamshed<tr valign="top" align="left">
71*91df013fSAsim Jamshed<td width="11%"></td>
72*91df013fSAsim Jamshed<td width="23%">
73*91df013fSAsim Jamshed
74*91df013fSAsim Jamshed
75*91df013fSAsim Jamshed<p><i>num_cores</i></p></td>
76*91df013fSAsim Jamshed<td width="8%"></td>
77*91df013fSAsim Jamshed<td width="58%">
78*91df013fSAsim Jamshed
79*91df013fSAsim Jamshed
80*91df013fSAsim Jamshed<p>An integer that shows the total number of cores the mOS
81*91df013fSAsim Jamshedcore is using.</p></td></tr>
82*91df013fSAsim Jamshed<tr valign="top" align="left">
83*91df013fSAsim Jamshed<td width="11%"></td>
84*91df013fSAsim Jamshed<td width="23%">
85*91df013fSAsim Jamshed
86*91df013fSAsim Jamshed
87*91df013fSAsim Jamshed<p><i>max_concurrency</i></p></td>
88*91df013fSAsim Jamshed<td width="8%"></td>
89*91df013fSAsim Jamshed<td width="58%">
90*91df013fSAsim Jamshed
91*91df013fSAsim Jamshed
92*91df013fSAsim Jamshed<p>An integer that holds how many ongoing flows each core
93*91df013fSAsim Jamshedthread manages concurrently. Default value is 100000.</p></td></tr>
94*91df013fSAsim Jamshed<tr valign="top" align="left">
95*91df013fSAsim Jamshed<td width="11%"></td>
96*91df013fSAsim Jamshed<td width="23%">
97*91df013fSAsim Jamshed
98*91df013fSAsim Jamshed
99*91df013fSAsim Jamshed<p><i>max_num_buffers</i></p></td>
100*91df013fSAsim Jamshed<td width="8%"></td>
101*91df013fSAsim Jamshed<td width="58%">
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed
104*91df013fSAsim Jamshed<p>An integer that holds the maximum number of socket
105*91df013fSAsim Jamshedbuffers each core thread can hold. Default value is
106*91df013fSAsim Jamshed100000.</p> </td></tr>
107*91df013fSAsim Jamshed<tr valign="top" align="left">
108*91df013fSAsim Jamshed<td width="11%"></td>
109*91df013fSAsim Jamshed<td width="23%">
110*91df013fSAsim Jamshed
111*91df013fSAsim Jamshed
112*91df013fSAsim Jamshed<p><i>rcvbuf_size</i></p></td>
113*91df013fSAsim Jamshed<td width="8%"></td>
114*91df013fSAsim Jamshed<td width="58%">
115*91df013fSAsim Jamshed
116*91df013fSAsim Jamshed
117*91df013fSAsim Jamshed<p>An integer that holds the size of the TCP receive
118*91df013fSAsim Jamshedbuffer. Default value is 8KB.</p></td></tr>
119*91df013fSAsim Jamshed<tr valign="top" align="left">
120*91df013fSAsim Jamshed<td width="11%"></td>
121*91df013fSAsim Jamshed<td width="23%">
122*91df013fSAsim Jamshed
123*91df013fSAsim Jamshed
124*91df013fSAsim Jamshed<p><i>tcp_timeout</i></p></td>
125*91df013fSAsim Jamshed<td width="8%"></td>
126*91df013fSAsim Jamshed<td width="58%">
127*91df013fSAsim Jamshed
128*91df013fSAsim Jamshed
129*91df013fSAsim Jamshed<p>An integer that holds the idle flow expiry timeout of
130*91df013fSAsim Jamshedthe monitoring flow. Default value is 30 secs.</p></td></tr>
131*91df013fSAsim Jamshed</table>
132*91df013fSAsim Jamshed
133*91df013fSAsim Jamshed<h2>RETURN VALUE
134*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
135*91df013fSAsim Jamshed</h2>
136*91df013fSAsim Jamshed
137*91df013fSAsim Jamshed
138*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on
139*91df013fSAsim Jamshedsuccess; -1 on failure and <i>errno</i> is set
140*91df013fSAsim Jamshedappropriately.</p>
141*91df013fSAsim Jamshed
142*91df013fSAsim Jamshed<h2>ERRORS
143*91df013fSAsim Jamshed<a name="ERRORS"></a>
144*91df013fSAsim Jamshed</h2>
145*91df013fSAsim Jamshed
146*91df013fSAsim Jamshed
147*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
148*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
149*91df013fSAsim Jamshed<tr valign="top" align="left">
150*91df013fSAsim Jamshed<td width="11%"></td>
151*91df013fSAsim Jamshed<td width="9%">
152*91df013fSAsim Jamshed
153*91df013fSAsim Jamshed
154*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EINVAL</b></p></td>
155*91df013fSAsim Jamshed<td width="6%"></td>
156*91df013fSAsim Jamshed<td width="40%">
157*91df013fSAsim Jamshed
158*91df013fSAsim Jamshed
159*91df013fSAsim Jamshed<p style="margin-top: 1em">The <i>conf</i> argument is
160*91df013fSAsim JamshedNULL.</p> </td>
161*91df013fSAsim Jamshed<td width="34%">
162*91df013fSAsim Jamshed</td></tr>
163*91df013fSAsim Jamshed</table>
164*91df013fSAsim Jamshed
165*91df013fSAsim Jamshed<h2>NOTES
166*91df013fSAsim Jamshed<a name="NOTES"></a>
167*91df013fSAsim Jamshed</h2>
168*91df013fSAsim Jamshed
169*91df013fSAsim Jamshed
170*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">See
171*91df013fSAsim Jamshed<i>http://mos.kaist.edu/guide/walkthrough/05_configuration.html</i>
172*91df013fSAsim Jamshedto view example startup mOS configuration file.</p>
173*91df013fSAsim Jamshed
174*91df013fSAsim Jamshed<h2>AUTHORS
175*91df013fSAsim Jamshed<a name="AUTHORS"></a>
176*91df013fSAsim Jamshed</h2>
177*91df013fSAsim Jamshed
178*91df013fSAsim Jamshed
179*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
180*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
181*91df013fSAsim Jamshed
182*91df013fSAsim Jamshed<h2>SEE ALSO
183*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
184*91df013fSAsim Jamshed</h2>
185*91df013fSAsim Jamshed
186*91df013fSAsim Jamshed
187*91df013fSAsim Jamshed
188*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_setconf</b>()</p>
189*91df013fSAsim Jamshed
190*91df013fSAsim Jamshed<h2>COLOPHON
191*91df013fSAsim Jamshed<a name="COLOPHON"></a>
192*91df013fSAsim Jamshed</h2>
193*91df013fSAsim Jamshed
194*91df013fSAsim Jamshed
195*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
196*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
197*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
198*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
199*91df013fSAsim Jamshed<hr>
200*91df013fSAsim Jamshed</body>
201*91df013fSAsim Jamshed</html>
202