1*e5df9dc1SAsim Jamshed<!-- Creator : groff version 1.22.3 --> 2*e5df9dc1SAsim Jamshed<!-- CreationDate: Mon Aug 28 07:57:52 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_raise_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_raise_event</h1> 22*e5df9dc1SAsim Jamshed<!-- 23*e5df9dc1SAsim Jamshed<a href="#NAME">NAME</a><br> 24*e5df9dc1SAsim Jamshed<a href="#SYNOPSIS">SYNOPSIS</a><br> 25*e5df9dc1SAsim Jamshed<a href="#DESCRIPTION">DESCRIPTION</a><br> 26*e5df9dc1SAsim Jamshed<a href="#RETURN VALUE">RETURN VALUE</a><br> 27*e5df9dc1SAsim Jamshed<a href="#AUTHORS">AUTHORS</a><br> 28*e5df9dc1SAsim Jamshed<a href="#SEE ALSO">SEE ALSO</a><br> 29*e5df9dc1SAsim Jamshed<a href="#COLOPHON">COLOPHON</a><br> 30*e5df9dc1SAsim Jamshed 31*e5df9dc1SAsim Jamshed<hr> 32*e5df9dc1SAsim Jamshed--> 33*e5df9dc1SAsim Jamshed 34*e5df9dc1SAsim Jamshed<h2>NAME 35*e5df9dc1SAsim Jamshed<a name="NAME"></a> 36*e5df9dc1SAsim Jamshed</h2> 37*e5df9dc1SAsim Jamshed 38*e5df9dc1SAsim Jamshed 39*e5df9dc1SAsim Jamshed 40*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">mtcp_raise_event 41*e5df9dc1SAsim Jamshed− raise a child event for a multi-event filter</p> 42*e5df9dc1SAsim Jamshed 43*e5df9dc1SAsim Jamshed<h2>SYNOPSIS 44*e5df9dc1SAsim Jamshed<a name="SYNOPSIS"></a> 45*e5df9dc1SAsim Jamshed</h2> 46*e5df9dc1SAsim Jamshed 47*e5df9dc1SAsim Jamshed 48*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>#include 49*e5df9dc1SAsim Jamshed<mos_api.h></b></p> 50*e5df9dc1SAsim Jamshed 51*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>int 52*e5df9dc1SAsim Jamshedmtcp_raise_event(mctx_t</b> <i>mctx</i><b>, event_t</b> 53*e5df9dc1SAsim Jamshed<i>child_event</i><b>);</b></p> 54*e5df9dc1SAsim Jamshed 55*e5df9dc1SAsim Jamshed<h2>DESCRIPTION 56*e5df9dc1SAsim Jamshed<a name="DESCRIPTION"></a> 57*e5df9dc1SAsim Jamshed</h2> 58*e5df9dc1SAsim Jamshed 59*e5df9dc1SAsim Jamshed 60*e5df9dc1SAsim Jamshed 61*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em"><b>mtcp_raise_event</b>() 62*e5df9dc1SAsim Jamshedraises a child event <i>child_event</i> , in turn, the 63*e5df9dc1SAsim Jamshedcallback functions and the filter functions registered to 64*e5df9dc1SAsim Jamshedthe child event will be triggered.</p> 65*e5df9dc1SAsim Jamshed 66*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">The 67*e5df9dc1SAsim Jamshed<i>child_event</i> should be a event that is allocated via 68*e5df9dc1SAsim Jamshed<b>mtcp_alloc_event ()</b> or user-defined events which is 69*e5df9dc1SAsim Jamshedcreated via <b>mtcp_define_event ()</b> are triggered 70*e5df9dc1SAsim Jamshedautomatically by mOS core based on its condition, and those 71*e5df9dc1SAsim Jamshedevents are not allowed to be triggered by 72*e5df9dc1SAsim Jamshed<b>mtcp_alloc_event ()</b></p> 73*e5df9dc1SAsim Jamshed 74*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">This function 75*e5df9dc1SAsim Jamshedis designed to be called inside event-filter functions, so 76*e5df9dc1SAsim Jamshedthat a single filter can trigger a set of multiple child 77*e5df9dc1SAsim Jamshedevents based on the processing result inside the filter 78*e5df9dc1SAsim Jamshedfunction.</p> 79*e5df9dc1SAsim Jamshed 80*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">For example, a 81*e5df9dc1SAsim Jamshedfilter function can be a string-pattern matching function 82*e5df9dc1SAsim Jamshedthat finds for multiple possible patterns. According to the 83*e5df9dc1SAsim Jamshedpattern-matching result, it can trigger multiple child 84*e5df9dc1SAsim Jamshedevents that corresponds to each pattern. In this case, 85*e5df9dc1SAsim Jamshed<b>mtcp_raise_event</b>() can be called multiple times 86*e5df9dc1SAsim Jamshedinside the filter function for each pattern found in the 87*e5df9dc1SAsim Jamshedgiven string.</p> 88*e5df9dc1SAsim Jamshed 89*e5df9dc1SAsim Jamshed<h2>RETURN VALUE 90*e5df9dc1SAsim Jamshed<a name="RETURN VALUE"></a> 91*e5df9dc1SAsim Jamshed</h2> 92*e5df9dc1SAsim Jamshed 93*e5df9dc1SAsim Jamshed 94*e5df9dc1SAsim Jamshed<p style="margin-left:11%; margin-top: 1em">Returns 0 on 95*e5df9dc1SAsim Jamshedsuccess. When the given <i>child_event</i> parameter points 96*e5df9dc1SAsim Jamshedto any event that is undefined or invalid (not the one 97*e5df9dc1SAsim Jamshedcreated via <b>mtcp_alloc_event()</b> ), it fails and 98*e5df9dc1SAsim Jamshedreturns -1.</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 <[email protected]></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_alloc_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