<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>oRTP: include/ortp/event.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">oRTP
 <span id="projectnumber">0.22.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_c54cf482d11bde8df616114128d61669.html">ortp</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">event.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>  <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright (C) 2001 Simon MORLAT simon.morlat@linphone.org</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> This library is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> modify it under the terms of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> License as published by the Free Software Foundation; either</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> This library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> You should have received a copy of the GNU Lesser General Public</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> License along with this library; if not, write to the Free Software</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef ortp_events_h</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor"></span><span class="preprocessor">#define ortp_events_h</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ortp/str_utils.h></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">typedef</span> <a class="code" href="structmsgb.html">mblk_t</a> <a class="code" href="structmsgb.html">OrtpEvent</a>;</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> OrtpEventType;</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  OrtpRTPSocket,</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  OrtpRTCPSocket</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> } OrtpSocketType;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structRtpEndpoint.html"> 34</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structRtpEndpoint.html">RtpEndpoint</a>{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#ifdef ORTP_INET6</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span> <span class="keyword">struct </span>sockaddr_storage addr;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span> <span class="keyword">struct </span>sockaddr addr;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span> socklen_t addrlen;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> }<a class="code" href="structRtpEndpoint.html">RtpEndpoint</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="struct__OrtpEventData.html"> 44</a></span> <span class="keyword">struct </span><a class="code" href="struct__OrtpEventData.html">_OrtpEventData</a>{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="structmsgb.html">mblk_t</a> *packet; <span class="comment">/* most events are associated to a received packet */</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="structRtpEndpoint.html">RtpEndpoint</a> *ep;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="structortpTimeSpec.html">ortpTimeSpec</a> ts;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">union </span>{</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">int</span> telephone_event;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordtype">int</span> payload_type;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  bool_t zrtp_stream_encrypted;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keyword">struct </span>_ZrtpSas{</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">char</span> sas[5]; <span class="comment">// 4 characters</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  bool_t verified;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  } zrtp_sas;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  OrtpSocketType socket_type;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  bool_t ice_processing_successful;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  } info;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct__OrtpEventData.html">_OrtpEventData</a> <a class="code" href="struct__OrtpEventData.html">OrtpEventData</a>;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>{</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> ORTP_PUBLIC <a class="code" href="structRtpEndpoint.html">RtpEndpoint</a> *rtp_endpoint_new(<span class="keyword">struct</span> sockaddr *addr, socklen_t addrlen);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> ORTP_PUBLIC <a class="code" href="structRtpEndpoint.html">RtpEndpoint</a> *rtp_endpoint_dup(<span class="keyword">const</span> <a class="code" href="structRtpEndpoint.html">RtpEndpoint</a> *ep);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> ORTP_PUBLIC <a class="code" href="structmsgb.html">OrtpEvent</a> * ortp_event_new(OrtpEventType tp);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> ORTP_PUBLIC OrtpEventType ortp_event_get_type(<span class="keyword">const</span> <a class="code" href="structmsgb.html">OrtpEvent</a> *ev);</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">/* type is one of the following*/</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="preprocessor">#define ORTP_EVENT_STUN_PACKET_RECEIVED 1</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_PAYLOAD_TYPE_CHANGED 2</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_TELEPHONE_EVENT 3</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_RTCP_PACKET_RECEIVED 4 </span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="preprocessor">#define ORTP_EVENT_RTCP_PACKET_EMITTED 5 </span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="preprocessor">#define ORTP_EVENT_ZRTP_ENCRYPTION_CHANGED 6</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ZRTP_SAS_READY 7</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ICE_CHECK_LIST_PROCESSING_FINISHED 8</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ICE_SESSION_PROCESSING_FINISHED 9</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ICE_GATHERING_FINISHED 10</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ICE_LOSING_PAIRS_COMPLETED 11</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor"></span><span class="preprocessor">#define ORTP_EVENT_ICE_RESTART_NEEDED 12</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> ORTP_PUBLIC <a class="code" href="struct__OrtpEventData.html">OrtpEventData</a> * ortp_event_get_data(<a class="code" href="structmsgb.html">OrtpEvent</a> *ev);</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> ORTP_PUBLIC <span class="keywordtype">void</span> ortp_event_destroy(<a class="code" href="structmsgb.html">OrtpEvent</a> *ev);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> ORTP_PUBLIC <a class="code" href="structmsgb.html">OrtpEvent</a> *ortp_event_dup(<a class="code" href="structmsgb.html">OrtpEvent</a> *ev);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="structOrtpEvQueue.html"> 92</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a>{</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <a class="code" href="struct__queue.html">queue_t</a> q;</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  ortp_mutex_t mutex;</div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> } <a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> ORTP_PUBLIC <a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a> * ortp_ev_queue_new(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> ORTP_PUBLIC <span class="keywordtype">void</span> ortp_ev_queue_destroy(<a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a> *q);</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> ORTP_PUBLIC <a class="code" href="structmsgb.html">OrtpEvent</a> * ortp_ev_queue_get(<a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a> *q);</div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> ORTP_PUBLIC <span class="keywordtype">void</span> ortp_ev_queue_flush(<a class="code" href="structOrtpEvQueue.html">OrtpEvQueue</a> * qp);</div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="preprocessor"></span>}</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor"></span></div>
<div class="ttc" id="structortpTimeSpec_html"><div class="ttname"><a href="structortpTimeSpec.html">ortpTimeSpec</a></div><div class="ttdef"><b>Definition:</b> port.h:260</div></div>
<div class="ttc" id="structmsgb_html"><div class="ttname"><a href="structmsgb.html">msgb</a></div><div class="ttdef"><b>Definition:</b> str_utils.h:49</div></div>
<div class="ttc" id="struct__OrtpEventData_html"><div class="ttname"><a href="struct__OrtpEventData.html">_OrtpEventData</a></div><div class="ttdef"><b>Definition:</b> event.h:44</div></div>
<div class="ttc" id="struct__queue_html"><div class="ttname"><a href="struct__queue.html">_queue</a></div><div class="ttdef"><b>Definition:</b> str_utils.h:75</div></div>
<div class="ttc" id="structOrtpEvQueue_html"><div class="ttname"><a href="structOrtpEvQueue.html">OrtpEvQueue</a></div><div class="ttdef"><b>Definition:</b> event.h:92</div></div>
<div class="ttc" id="structRtpEndpoint_html"><div class="ttname"><a href="structRtpEndpoint.html">RtpEndpoint</a></div><div class="ttdef"><b>Definition:</b> event.h:34</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Oct 19 2013 07:09:42 for oRTP by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
