1*e5df9dc1SAsim Jamshed<!-- Creator     : groff version 1.22.3 -->
2*e5df9dc1SAsim Jamshed<!-- CreationDate: Mon Aug 28 07:57:51 2017 -->
3*e5df9dc1SAsim Jamshed<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
4*e5df9dc1SAsim Jamshed"http://www.w3.org/TR/html4/loose.dtd">
5*e5df9dc1SAsim Jamshed<html>
6*e5df9dc1SAsim Jamshed<head>
7*e5df9dc1SAsim Jamshed<meta name="generator" content="groff -Thtml, see www.gnu.org">
8*e5df9dc1SAsim Jamshed<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
9*e5df9dc1SAsim Jamshed<meta name="Content-Style" content="text/css">
10*e5df9dc1SAsim Jamshed<style type="text/css">
11*e5df9dc1SAsim Jamshed       p       { margin-top: 0; margin-bottom: 0; vertical-align: top }
12*e5df9dc1SAsim Jamshed       pre     { margin-top: 0; margin-bottom: 0; vertical-align: top }
13*e5df9dc1SAsim Jamshed       table   { margin-top: 0; margin-bottom: 0; vertical-align: top }
14*e5df9dc1SAsim Jamshed       h1      { text-align: center }
15*e5df9dc1SAsim Jamshed</style>
16*e5df9dc1SAsim Jamshed<title>mtcp_alloc_event</title>
17*e5df9dc1SAsim Jamshed<link rel="stylesheet" href="./common.css">
18*e5df9dc1SAsim Jamshed</head>
19*e5df9dc1SAsim Jamshed<body>
20*e5df9dc1SAsim Jamshed<div class="main">
21*e5df9dc1SAsim Jamshed<h1 align="center">mtcp_alloc_event</h1>
22*e5df9dc1SAsim Jamshed
23*e5df9dc1SAsim Jamshed<!--
24*e5df9dc1SAsim Jamshed<a href="#NAME">NAME</a><br>
25*e5df9dc1SAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br>
26*e5df9dc1SAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br>
27*e5df9dc1SAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br>
28*e5df9dc1SAsim Jamshed<a href="#ERRORS">ERRORS</a><br>
29*e5df9dc1SAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br>
30*e5df9dc1SAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br>
31*e5df9dc1SAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br>
32*e5df9dc1SAsim Jamshed
33*e5df9dc1SAsim Jamshed<hr>
34*e5df9dc1SAsim Jamshed-->
35*e5df9dc1SAsim Jamshed
36*e5df9dc1SAsim Jamshed<h2>NAME
37*e5df9dc1SAsim Jamshed<a name="NAME"></a>
38*e5df9dc1SAsim Jamshed</h2>
39*e5df9dc1SAsim Jamshed
40*e5df9dc1SAsim Jamshed
41*e5df9dc1SAsim Jamshed
42*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_alloc_event
43*e5df9dc1SAsim Jamshed&minus; define a follow-up event for a filter that can
44*e5df9dc1SAsim Jamshedtrigger multiple (child) events</p>
45*e5df9dc1SAsim Jamshed
46*e5df9dc1SAsim Jamshed<h2>SYNOPSIS
47*e5df9dc1SAsim Jamshed<a name="SYNOPSIS"></a>
48*e5df9dc1SAsim Jamshed</h2>
49*e5df9dc1SAsim Jamshed
50*e5df9dc1SAsim Jamshed
51*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include
52*e5df9dc1SAsim Jamshed&lt;mos_api.h&gt;</b></p>
53*e5df9dc1SAsim Jamshed
54*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>event_t
55*e5df9dc1SAsim Jamshedmtcp_alloc_event(event_t</b>
56*e5df9dc1SAsim Jamshed<i>parent_event</i><b>);</b></p>
57*e5df9dc1SAsim Jamshed
58*e5df9dc1SAsim Jamshed<h2>DESCRIPTION
59*e5df9dc1SAsim Jamshed<a name="DESCRIPTION"></a>
60*e5df9dc1SAsim Jamshed</h2>
61*e5df9dc1SAsim Jamshed
62*e5df9dc1SAsim Jamshed
63*e5df9dc1SAsim Jamshed
64*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_alloc_event</b>()
65*e5df9dc1SAsim Jamshedallocates a new child event that can be triggered by a
66*e5df9dc1SAsim Jamshedfilter. On success, it returns a child event that can be
67*e5df9dc1SAsim Jamshedtriggered inside the filter functions registered on
68*e5df9dc1SAsim Jamshed<i>parent_event</i></p>
69*e5df9dc1SAsim Jamshed
70*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This function
71*e5df9dc1SAsim Jamshedallows a single filter to trigger a set of multiple child
72*e5df9dc1SAsim Jamshedevents based on the processing result inside the filter
73*e5df9dc1SAsim Jamshedfunction. More specifically, a user can call this function
74*e5df9dc1SAsim Jamshedto pre-allocate a child user-defined event when initializing
75*e5df9dc1SAsim JamshedmOS events, providing its parent event <i>parent_event</i>
76*e5df9dc1SAsim Jamshedregistered to the parent event are triggered. The filter
77*e5df9dc1SAsim Jamshedfunction, based on its result, can trigger the child event
78*e5df9dc1SAsim Jamshedcreated with <b>mtcp_alloc_event ()</b> using the
79*e5df9dc1SAsim Jamshed<b>mtcp_raise_event ()</b> function.</p>
80*e5df9dc1SAsim Jamshed
81*e5df9dc1SAsim Jamshed<h2>RETURN VALUE
82*e5df9dc1SAsim Jamshed<a name="RETURN VALUE"></a>
83*e5df9dc1SAsim Jamshed</h2>
84*e5df9dc1SAsim Jamshed
85*e5df9dc1SAsim Jamshed
86*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns
87*e5df9dc1SAsim Jamshed<i>event_t</i> on success; <i>MOS_NULL_EVENT on
88*e5df9dc1SAsim Jamshedfailure.</i></p>
89*e5df9dc1SAsim Jamshed
90*e5df9dc1SAsim Jamshed<h2>ERRORS
91*e5df9dc1SAsim Jamshed<a name="ERRORS"></a>
92*e5df9dc1SAsim Jamshed</h2>
93*e5df9dc1SAsim Jamshed
94*e5df9dc1SAsim Jamshed
95*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This function
96*e5df9dc1SAsim Jamshedreturns <i>MOS_NULL_EVENT</i> when the
97*e5df9dc1SAsim Jamshedgiven <i>parent_event</i> is not defined or cannot allocate
98*e5df9dc1SAsim Jamshedmore <i>event_t</i> structure.</p>
99*e5df9dc1SAsim Jamshed
100*e5df9dc1SAsim Jamshed<h2>AUTHORS
101*e5df9dc1SAsim Jamshed<a name="AUTHORS"></a>
102*e5df9dc1SAsim Jamshed</h2>
103*e5df9dc1SAsim Jamshed
104*e5df9dc1SAsim Jamshed
105*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mOS development
106*e5df9dc1SAsim Jamshedteam &lt;[email protected]&gt;</p>
107*e5df9dc1SAsim Jamshed
108*e5df9dc1SAsim Jamshed<h2>SEE ALSO
109*e5df9dc1SAsim Jamshed<a name="SEE ALSO"></a>
110*e5df9dc1SAsim Jamshed</h2>
111*e5df9dc1SAsim Jamshed
112*e5df9dc1SAsim Jamshed
113*e5df9dc1SAsim Jamshed
114*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_raise_event</b>(),
115*e5df9dc1SAsim Jamshed<b>mtcp_define_event</b>()</p>
116*e5df9dc1SAsim Jamshed
117*e5df9dc1SAsim Jamshed<h2>COLOPHON
118*e5df9dc1SAsim Jamshed<a name="COLOPHON"></a>
119*e5df9dc1SAsim Jamshed</h2>
120*e5df9dc1SAsim Jamshed
121*e5df9dc1SAsim Jamshed
122*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This page is
123*e5df9dc1SAsim Jamshedpart of mOS release 0.3 <i>docs</i> section. A description
124*e5df9dc1SAsim Jamshedof the project, and information about reporting bugs, can be
125*e5df9dc1SAsim Jamshedfound at http://mos.kaist.edu/.</p>
126*e5df9dc1SAsim Jamshed<hr>
127*e5df9dc1SAsim Jamshed<div class="footer">
128*e5df9dc1SAsim Jamshed  <img src="back-arrow.jpg" width="2%" height="2%"><a href="http://mos.kaist.edu/index_man.html">Back to Index</a>
129*e5df9dc1SAsim Jamshed</div>
130*e5df9dc1SAsim Jamshed</div>
131*e5df9dc1SAsim Jamshed</body>
132*e5df9dc1SAsim Jamshed</html>
133