1*91df013fSAsim Jamshed<!-- Creator     : groff version 1.22.2 -->
2*91df013fSAsim Jamshed<!-- CreationDate: Fri Feb  3 21:15:47 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_get_uctx</title>
17*91df013fSAsim Jamshed
18*91df013fSAsim Jamshed</head>
19*91df013fSAsim Jamshed<body>
20*91df013fSAsim Jamshed
21*91df013fSAsim Jamshed<h1 align="center">mtcp_get_uctx</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="#AUTHORS">AUTHORS</a><br>
29*91df013fSAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
30*91df013fSAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
31*91df013fSAsim Jamshed
32*91df013fSAsim Jamshed<hr>
33*91df013fSAsim Jamshed
34*91df013fSAsim Jamshed
35*91df013fSAsim Jamshed<h2>NAME
36*91df013fSAsim Jamshed<a name="NAME"></a>
37*91df013fSAsim Jamshed</h2>
38*91df013fSAsim Jamshed
39*91df013fSAsim Jamshed
40*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_get_uctx
41*91df013fSAsim Jamshed&minus; get private per-flow user-context data</p>
42*91df013fSAsim Jamshed
43*91df013fSAsim Jamshed<h2>SYNOPSIS
44*91df013fSAsim Jamshed<a name="SYNOPSIS"></a>
45*91df013fSAsim Jamshed</h2>
46*91df013fSAsim Jamshed
47*91df013fSAsim Jamshed
48*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
49*91df013fSAsim Jamshed&lt;mos_api.h&gt;</b></p>
50*91df013fSAsim Jamshed
51*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int
52*91df013fSAsim Jamshedmtcp_get_uctx(mctx_t</b> <i>mctx</i><b>, int</b>
53*91df013fSAsim Jamshed<i>sockid</i><b>);</b></p>
54*91df013fSAsim Jamshed
55*91df013fSAsim Jamshed<h2>DESCRIPTION
56*91df013fSAsim Jamshed<a name="DESCRIPTION"></a>
57*91df013fSAsim Jamshed</h2>
58*91df013fSAsim Jamshed
59*91df013fSAsim Jamshed
60*91df013fSAsim Jamshed
61*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_get_uctx</b>()
62*91df013fSAsim Jamshedcan be used to retrieve flow-specific monitoring data to a
63*91df013fSAsim Jamshedflow record in the application layer. It is generally used
64*91df013fSAsim Jamshedin tandem with <b>mtcp_set_uctx</b>()<b>.</b> The
65*91df013fSAsim Jamshedflow-specific data is stored with the socket that can
66*91df013fSAsim Jamshedreferred to by the <i>sockid</i> argument. The private data
67*91df013fSAsim Jamshedcan be stored as a void *. It is the responsibility of the
68*91df013fSAsim Jamsheduser to free up the private data (if it is dynamically
69*91df013fSAsim Jamshedallocated from memory) when the flow record gets deleted
70*91df013fSAsim Jamshedfrom the stack (due to, e.g., connection termination).</p>
71*91df013fSAsim Jamshed
72*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The
73*91df013fSAsim Jamshed<b>mtcp_get_uctx</b>() call takes an additional argument
74*91df013fSAsim Jamshednamed <i>mctx</i> that represents the per-core mTCP context
75*91df013fSAsim Jamshedin an application (see <b>mtcp_create_context()</b> for
76*91df013fSAsim Jamsheddetails).</p>
77*91df013fSAsim Jamshed
78*91df013fSAsim Jamshed<h2>RETURN VALUE
79*91df013fSAsim Jamshed<a name="RETURN VALUE"></a>
80*91df013fSAsim Jamshed</h2>
81*91df013fSAsim Jamshed
82*91df013fSAsim Jamshed
83*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns pointer
84*91df013fSAsim Jamshedto the private data as void * on success; NULL on failure.
85*91df013fSAsim JamshedIn case of failure, <i>errno</i> is set appropriately.</p>
86*91df013fSAsim Jamshed
87*91df013fSAsim Jamshed<h2>ERRORS
88*91df013fSAsim Jamshed<a name="ERRORS"></a>
89*91df013fSAsim Jamshed</h2>
90*91df013fSAsim Jamshed
91*91df013fSAsim Jamshed
92*91df013fSAsim Jamshed<table width="100%" border="0" rules="none" frame="void"
93*91df013fSAsim Jamshed       cellspacing="0" cellpadding="0">
94*91df013fSAsim Jamshed<tr valign="top" align="left">
95*91df013fSAsim Jamshed<td width="11%"></td>
96*91df013fSAsim Jamshed<td width="9%">
97*91df013fSAsim Jamshed
98*91df013fSAsim Jamshed
99*91df013fSAsim Jamshed<p style="margin-top: 1em"><b>EACCES</b></p></td>
100*91df013fSAsim Jamshed<td width="6%"></td>
101*91df013fSAsim Jamshed<td width="74%">
102*91df013fSAsim Jamshed
103*91df013fSAsim Jamshed
104*91df013fSAsim Jamshed<p style="margin-top: 1em"><i>mctx</i> is not a valid.</p></td></tr>
105*91df013fSAsim Jamshed<tr valign="top" align="left">
106*91df013fSAsim Jamshed<td width="11%"></td>
107*91df013fSAsim Jamshed<td width="9%">
108*91df013fSAsim Jamshed
109*91df013fSAsim Jamshed
110*91df013fSAsim Jamshed<p><b>EBADF</b></p></td>
111*91df013fSAsim Jamshed<td width="6%"></td>
112*91df013fSAsim Jamshed<td width="74%">
113*91df013fSAsim Jamshed
114*91df013fSAsim Jamshed
115*91df013fSAsim Jamshed<p><i>sockid</i> is not a valid socket descriptor for
116*91df013fSAsim Jamshedbinding to an address.</p></td></tr>
117*91df013fSAsim Jamshed<tr valign="top" align="left">
118*91df013fSAsim Jamshed<td width="11%"></td>
119*91df013fSAsim Jamshed<td width="9%">
120*91df013fSAsim Jamshed
121*91df013fSAsim Jamshed
122*91df013fSAsim Jamshed<p><b>EPERM</b></p></td>
123*91df013fSAsim Jamshed<td width="6%"></td>
124*91df013fSAsim Jamshed<td width="74%">
125*91df013fSAsim Jamshed
126*91df013fSAsim Jamshed
127*91df013fSAsim Jamshed<p>The user does not have permission to access the
128*91df013fSAsim Jamsheddata.</p> </td></tr>
129*91df013fSAsim Jamshed</table>
130*91df013fSAsim Jamshed
131*91df013fSAsim Jamshed<h2>AUTHORS
132*91df013fSAsim Jamshed<a name="AUTHORS"></a>
133*91df013fSAsim Jamshed</h2>
134*91df013fSAsim Jamshed
135*91df013fSAsim Jamshed
136*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
137*91df013fSAsim Jamshedteam &lt;[email protected]&gt;</p>
138*91df013fSAsim Jamshed
139*91df013fSAsim Jamshed<h2>SEE ALSO
140*91df013fSAsim Jamshed<a name="SEE ALSO"></a>
141*91df013fSAsim Jamshed</h2>
142*91df013fSAsim Jamshed
143*91df013fSAsim Jamshed
144*91df013fSAsim Jamshed
145*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_socket</b>(),
146*91df013fSAsim Jamshed<b>mtcp_set_uctx</b>(),</p>
147*91df013fSAsim Jamshed
148*91df013fSAsim Jamshed<h2>COLOPHON
149*91df013fSAsim Jamshed<a name="COLOPHON"></a>
150*91df013fSAsim Jamshed</h2>
151*91df013fSAsim Jamshed
152*91df013fSAsim Jamshed
153*91df013fSAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
154*91df013fSAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
155*91df013fSAsim Jamshedof the project, and information about reporting bugs, can be
156*91df013fSAsim Jamshedfound at http://mos.kaist.edu/.</p>
157*91df013fSAsim Jamshed<hr>
158*91df013fSAsim Jamshed</body>
159*91df013fSAsim Jamshed</html>
160