<!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"/>
<title>oRTP: include/ortp/ortp.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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 class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<h1>include/ortp/ortp.h</h1><a href="ortp_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.</span>
<a name="l00003"></a>00003 <span class="comment"> Copyright (C) 2001 Simon MORLAT simon.morlat@linphone.org</span>
<a name="l00004"></a>00004 <span class="comment"></span>
<a name="l00005"></a>00005 <span class="comment"> This library is free software; you can redistribute it and/or</span>
<a name="l00006"></a>00006 <span class="comment"> modify it under the terms of the GNU Lesser General Public</span>
<a name="l00007"></a>00007 <span class="comment"> License as published by the Free Software Foundation; either</span>
<a name="l00008"></a>00008 <span class="comment"> version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This library is distributed in the hope that it will be useful,</span>
<a name="l00011"></a>00011 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> License along with this library; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
<a name="l00018"></a>00018 <span class="comment">*/</span>
<a name="l00019"></a>00019
<a name="l00064"></a>00064 <span class="preprocessor">#ifndef ORTP_H</span>
<a name="l00065"></a>00065 <span class="preprocessor"></span><span class="preprocessor">#define ORTP_H</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span>
<a name="l00067"></a>00067 <span class="preprocessor">#include <<a class="code" href="rtpsession_8h.html" title="The RtpSession api.">ortp/rtpsession.h</a>></span>
<a name="l00068"></a>00068 <span class="preprocessor">#include <<a class="code" href="sessionset_8h.html" title="Sending and receiving multiple streams together with only one thread.">ortp/sessionset.h</a>></span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00071"></a>00071 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span>
<a name="l00072"></a>00072 {
<a name="l00073"></a>00073 <span class="preprocessor">#endif</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span>
<a name="l00075"></a>00075 bool_t ortp_min_version_required(<span class="keywordtype">int</span> major, <span class="keywordtype">int</span> minor, <span class="keywordtype">int</span> micro);
<a name="l00076"></a>00076 <span class="keywordtype">void</span> ortp_init(<span class="keywordtype">void</span>);
<a name="l00077"></a>00077 <span class="keywordtype">void</span> ortp_scheduler_init(<span class="keywordtype">void</span>);
<a name="l00078"></a>00078 <span class="keywordtype">void</span> ortp_exit(<span class="keywordtype">void</span>);
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">/***************/</span>
<a name="l00081"></a>00081 <span class="comment">/* logging api */</span>
<a name="l00082"></a>00082 <span class="comment">/***************/</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00085"></a>00085 ORTP_DEBUG=1,
<a name="l00086"></a>00086 ORTP_MESSAGE=1<<1,
<a name="l00087"></a>00087 ORTP_WARNING=1<<2,
<a name="l00088"></a>00088 ORTP_ERROR=1<<3,
<a name="l00089"></a>00089 ORTP_FATAL=1<<4,
<a name="l00090"></a>00090 ORTP_LOGLEV_END=1<<5
<a name="l00091"></a>00091 } OrtpLogLevel;
<a name="l00092"></a>00092
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">typedef</span> void (*OrtpLogFunc)(OrtpLogLevel lev, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, va_list args);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordtype">void</span> ortp_set_log_file(FILE *file);
<a name="l00097"></a>00097 <span class="keywordtype">void</span> ortp_set_log_handler(OrtpLogFunc func);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 VAR_DECLSPEC OrtpLogFunc ortp_logv_out;
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keyword">extern</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> __ortp_log_mask;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="preprocessor">#define ortp_log_level_enabled(level) (__ortp_log_mask & (level))</span>
<a name="l00104"></a>00104 <span class="preprocessor"></span>
<a name="l00105"></a>00105 <span class="preprocessor">#if !defined(WIN32) && !defined(_WIN32_WCE)</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="preprocessor">#define ortp_logv(level,fmt,args) \</span>
<a name="l00107"></a>00107 <span class="preprocessor">{\</span>
<a name="l00108"></a>00108 <span class="preprocessor"> if (ortp_logv_out!=NULL && ortp_log_level_enabled(level)) \</span>
<a name="l00109"></a>00109 <span class="preprocessor"> ortp_logv_out(level,fmt,args);\</span>
<a name="l00110"></a>00110 <span class="preprocessor"> if ((level)==ORTP_FATAL) abort();\</span>
<a name="l00111"></a>00111 <span class="preprocessor">}while(0)</span>
<a name="l00112"></a>00112 <span class="preprocessor"></span><span class="preprocessor">#else</span>
<a name="l00113"></a>00113 <span class="preprocessor"></span><span class="keywordtype">void</span> ortp_logv(<span class="keywordtype">int</span> level, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt, va_list args);
<a name="l00114"></a>00114 <span class="preprocessor">#endif</span>
<a name="l00115"></a>00115 <span class="preprocessor"></span>
<a name="l00116"></a>00116 <span class="keywordtype">void</span> ortp_set_log_level_mask(<span class="keywordtype">int</span> levelmask);
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="preprocessor">#ifdef ORTP_DEBUG_MODE</span>
<a name="l00119"></a>00119 <span class="preprocessor"></span><span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_debug(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 va_list args;
<a name="l00122"></a>00122 va_start (args, fmt);
<a name="l00123"></a>00123 ortp_logv(ORTP_DEBUG, fmt, args);
<a name="l00124"></a>00124 va_end (args);
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 <span class="preprocessor">#else</span>
<a name="l00127"></a>00127 <span class="preprocessor"></span>
<a name="l00128"></a>00128 <span class="preprocessor">#define ortp_debug(...)</span>
<a name="l00129"></a>00129 <span class="preprocessor"></span>
<a name="l00130"></a>00130 <span class="preprocessor">#endif</span>
<a name="l00131"></a>00131 <span class="preprocessor"></span>
<a name="l00132"></a>00132 <span class="preprocessor">#ifdef ORTP_NOMESSAGE_MODE</span>
<a name="l00133"></a>00133 <span class="preprocessor"></span>
<a name="l00134"></a>00134 <span class="preprocessor">#define ortp_log(...)</span>
<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="preprocessor">#define ortp_message(...)</span>
<a name="l00136"></a>00136 <span class="preprocessor"></span><span class="preprocessor">#define ortp_warning(...)</span>
<a name="l00137"></a>00137 <span class="preprocessor"></span>
<a name="l00138"></a>00138 <span class="preprocessor">#else</span>
<a name="l00139"></a>00139 <span class="preprocessor"></span>
<a name="l00140"></a>00140 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_log(OrtpLogLevel lev, <span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...){
<a name="l00141"></a>00141 va_list args;
<a name="l00142"></a>00142 va_start (args, fmt);
<a name="l00143"></a>00143 ortp_logv(lev, fmt, args);
<a name="l00144"></a>00144 va_end (args);
<a name="l00145"></a>00145 }
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_message(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...)
<a name="l00148"></a>00148 {
<a name="l00149"></a>00149 va_list args;
<a name="l00150"></a>00150 va_start (args, fmt);
<a name="l00151"></a>00151 ortp_logv(ORTP_MESSAGE, fmt, args);
<a name="l00152"></a>00152 va_end (args);
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_warning(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...)
<a name="l00156"></a>00156 {
<a name="l00157"></a>00157 va_list args;
<a name="l00158"></a>00158 va_start (args, fmt);
<a name="l00159"></a>00159 ortp_logv(ORTP_WARNING, fmt, args);
<a name="l00160"></a>00160 va_end (args);
<a name="l00161"></a>00161 }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="preprocessor">#endif</span>
<a name="l00164"></a>00164 <span class="preprocessor"></span>
<a name="l00165"></a>00165 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_error(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...)
<a name="l00166"></a>00166 {
<a name="l00167"></a>00167 va_list args;
<a name="l00168"></a>00168 va_start (args, fmt);
<a name="l00169"></a>00169 ortp_logv(ORTP_ERROR, fmt, args);
<a name="l00170"></a>00170 va_end (args);
<a name="l00171"></a>00171 }
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span> ortp_fatal(<span class="keyword">const</span> <span class="keywordtype">char</span> *fmt,...)
<a name="l00174"></a>00174 {
<a name="l00175"></a>00175 va_list args;
<a name="l00176"></a>00176 va_start (args, fmt);
<a name="l00177"></a>00177 ortp_logv(ORTP_FATAL, fmt, args);
<a name="l00178"></a>00178 va_end (args);
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180
<a name="l00181"></a>00181
<a name="l00182"></a>00182 <span class="comment">/****************/</span>
<a name="l00183"></a>00183 <span class="comment">/*statistics api*/</span>
<a name="l00184"></a>00184 <span class="comment">/****************/</span>
<a name="l00185"></a>00185
<a name="l00186"></a>00186 <span class="keyword">extern</span> <a class="code" href="structrtp__stats.html">rtp_stats_t</a> ortp_global_stats;
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="keywordtype">void</span> ortp_global_stats_reset(<span class="keywordtype">void</span>);
<a name="l00189"></a>00189 <a class="code" href="structrtp__stats.html">rtp_stats_t</a> *ortp_get_global_stats(<span class="keywordtype">void</span>);
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="keywordtype">void</span> ortp_global_stats_display(<span class="keywordtype">void</span>);
<a name="l00192"></a>00192 <span class="keywordtype">void</span> rtp_stats_display(<span class="keyword">const</span> <a class="code" href="structrtp__stats.html">rtp_stats_t</a> *stats, <span class="keyword">const</span> <span class="keywordtype">char</span> *header);
<a name="l00193"></a>00193 <span class="keywordtype">void</span> rtp_stats_reset(<a class="code" href="structrtp__stats.html">rtp_stats_t</a> *stats);
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00196"></a>00196 <span class="preprocessor"></span>}
<a name="l00197"></a>00197 <span class="preprocessor">#endif</span>
<a name="l00198"></a>00198 <span class="preprocessor"></span>
<a name="l00199"></a>00199 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 30 Nov 2009 for oRTP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
