docs/reference/libnice/html/libnice-STUN-Constants.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>STUN Constants: libnice Reference Manual</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
   7 <link rel="home" href="index.html" title="libnice Reference Manual">
   8 <link rel="up" href="ch03.html" title="">
   9 <link rel="prev" href="libnice-StunMessage.html" title="StunMessage">
  10 <link rel="next" href="ch04.html" title="STUN usages">
  11 <meta name="generator" content="GTK-Doc V1.29 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span>
  18                   <a href="#libnice-STUN-Constants.description" class="shortcut">Description</a></span>
  19 </td>
  20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="libnice-StunMessage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="ch04.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24 </tr></table>
  25 <div class="refentry">
  26 <a name="libnice-STUN-Constants"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="libnice-STUN-Constants.top_of_page"></a>STUN Constants</span></h2>
  30 <p>STUN Constants — STUN constants</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="libnice-STUN-Constants.stability-level"></a><h2>Stability Level</h2>
  36 <acronym title="The intention of a Stable interface is to enable arbitrary third parties to
  37 develop applications to these interfaces, release them, and have confidence that
  38 they will run on all minor releases of the product (after the one in which the
  39 interface was introduced, and within the same major release). Even at a major
  40 release, incompatible changes are expected to be rare, and to have strong
  41 justifications.
  42 "><span class="acronym">Stable</span></acronym>, unless otherwise indicated
  43 </div>
  44 <div class="refsect1">
  45 <a name="libnice-STUN-Constants.other"></a><h2>Types and Values</h2>
  46 <div class="informaltable"><table class="informaltable" width="100%" border="0">
  47 <colgroup>
  48 <col width="150px" class="name">
  49 <col class="description">
  50 </colgroup>
  51 <tbody>
  52 <tr>
  53 <td class="define_keyword">#define</td>
  54 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-AGENT-MAX-SAVED-IDS:CAPS" title="STUN_AGENT_MAX_SAVED_IDS">STUN_AGENT_MAX_SAVED_IDS</a></td>
  55 </tr>
  56 <tr>
  57 <td class="define_keyword">#define</td>
  58 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-AGENT-MAX-UNKNOWN-ATTRIBUTES:CAPS" title="STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES">STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES</a></td>
  59 </tr>
  60 <tr>
  61 <td class="define_keyword">#define</td>
  62 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-HEADER-LENGTH:CAPS" title="STUN_ATTRIBUTE_HEADER_LENGTH">STUN_ATTRIBUTE_HEADER_LENGTH</a></td>
  63 </tr>
  64 <tr>
  65 <td class="define_keyword">#define</td>
  66 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-LENGTH-LEN:CAPS" title="STUN_ATTRIBUTE_LENGTH_LEN">STUN_ATTRIBUTE_LENGTH_LEN</a></td>
  67 </tr>
  68 <tr>
  69 <td class="define_keyword">#define</td>
  70 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-LENGTH-POS:CAPS" title="STUN_ATTRIBUTE_LENGTH_POS">STUN_ATTRIBUTE_LENGTH_POS</a></td>
  71 </tr>
  72 <tr>
  73 <td class="define_keyword">#define</td>
  74 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-TYPE-LEN:CAPS" title="STUN_ATTRIBUTE_TYPE_LEN">STUN_ATTRIBUTE_TYPE_LEN</a></td>
  75 </tr>
  76 <tr>
  77 <td class="define_keyword">#define</td>
  78 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-TYPE-POS:CAPS" title="STUN_ATTRIBUTE_TYPE_POS">STUN_ATTRIBUTE_TYPE_POS</a></td>
  79 </tr>
  80 <tr>
  81 <td class="define_keyword">#define</td>
  82 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ATTRIBUTE-VALUE-POS:CAPS" title="STUN_ATTRIBUTE_VALUE_POS">STUN_ATTRIBUTE_VALUE_POS</a></td>
  83 </tr>
  84 <tr>
  85 <td class="define_keyword">#define</td>
  86 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-ID-LEN:CAPS" title="STUN_ID_LEN">STUN_ID_LEN</a></td>
  87 </tr>
  88 <tr>
  89 <td class="define_keyword">#define</td>
  90 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MAGIC-COOKIE:CAPS" title="STUN_MAGIC_COOKIE">STUN_MAGIC_COOKIE</a></td>
  91 </tr>
  92 <tr>
  93 <td class="define_keyword">#define</td>
  94 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MAX-MESSAGE-SIZE:CAPS" title="STUN_MAX_MESSAGE_SIZE">STUN_MAX_MESSAGE_SIZE</a></td>
  95 </tr>
  96 <tr>
  97 <td class="define_keyword">#define</td>
  98 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MAX-MESSAGE-SIZE-IPV4:CAPS" title="STUN_MAX_MESSAGE_SIZE_IPV4">STUN_MAX_MESSAGE_SIZE_IPV4</a></td>
  99 </tr>
 100 <tr>
 101 <td class="define_keyword">#define</td>
 102 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MAX-MESSAGE-SIZE-IPV6:CAPS" title="STUN_MAX_MESSAGE_SIZE_IPV6">STUN_MAX_MESSAGE_SIZE_IPV6</a></td>
 103 </tr>
 104 <tr>
 105 <td class="define_keyword">#define</td>
 106 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-ATTRIBUTES-POS:CAPS" title="STUN_MESSAGE_ATTRIBUTES_POS">STUN_MESSAGE_ATTRIBUTES_POS</a></td>
 107 </tr>
 108 <tr>
 109 <td class="define_keyword">#define</td>
 110 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-HEADER-LENGTH:CAPS" title="STUN_MESSAGE_HEADER_LENGTH">STUN_MESSAGE_HEADER_LENGTH</a></td>
 111 </tr>
 112 <tr>
 113 <td class="define_keyword">#define</td>
 114 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-LENGTH-LEN:CAPS" title="STUN_MESSAGE_LENGTH_LEN">STUN_MESSAGE_LENGTH_LEN</a></td>
 115 </tr>
 116 <tr>
 117 <td class="define_keyword">#define</td>
 118 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-LENGTH-POS:CAPS" title="STUN_MESSAGE_LENGTH_POS">STUN_MESSAGE_LENGTH_POS</a></td>
 119 </tr>
 120 <tr>
 121 <td class="define_keyword">#define</td>
 122 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-TRANS-ID-LEN:CAPS" title="STUN_MESSAGE_TRANS_ID_LEN">STUN_MESSAGE_TRANS_ID_LEN</a></td>
 123 </tr>
 124 <tr>
 125 <td class="define_keyword">#define</td>
 126 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-TRANS-ID-POS:CAPS" title="STUN_MESSAGE_TRANS_ID_POS">STUN_MESSAGE_TRANS_ID_POS</a></td>
 127 </tr>
 128 <tr>
 129 <td class="define_keyword">#define</td>
 130 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-TYPE-LEN:CAPS" title="STUN_MESSAGE_TYPE_LEN">STUN_MESSAGE_TYPE_LEN</a></td>
 131 </tr>
 132 <tr>
 133 <td class="define_keyword">#define</td>
 134 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#STUN-MESSAGE-TYPE-POS:CAPS" title="STUN_MESSAGE_TYPE_POS">STUN_MESSAGE_TYPE_POS</a></td>
 135 </tr>
 136 <tr>
 137 <td class="define_keyword">#define</td>
 138 <td class="function_name"><a class="link" href="libnice-STUN-Constants.html#TURN-MAGIC-COOKIE:CAPS" title="TURN_MAGIC_COOKIE">TURN_MAGIC_COOKIE</a></td>
 139 </tr>
 140 </tbody>
 141 </table></div>
 142 </div>
 143 <div class="refsect1">
 144 <a name="libnice-STUN-Constants.includes"></a><h2>Includes</h2>
 145 <pre class="synopsis">#include &lt;stun/constants.h&gt;
 146 </pre>
 147 </div>
 148 <div class="refsect1">
 149 <a name="libnice-STUN-Constants.description"></a><h2>Description</h2>
 150 <p>Various constants defining parts of the STUN and TURN protocols and
 151 on-the-wire packet formats.</p>
 152 </div>
 153 <div class="refsect1">
 154 <a name="libnice-STUN-Constants.functions_details"></a><h2>Functions</h2>
 155 <p></p>
 156 </div>
 157 <div class="refsect1">
 158 <a name="libnice-STUN-Constants.other_details"></a><h2>Types and Values</h2>
 159 <div class="refsect2">
 160 <a name="STUN-AGENT-MAX-SAVED-IDS:CAPS"></a><h3>STUN_AGENT_MAX_SAVED_IDS</h3>
 161 <pre class="programlisting">#define STUN_AGENT_MAX_SAVED_IDS 200
 162 </pre>
 163 <p>Maximum number of simultaneously ongoing STUN transactions.</p>
 164 </div>
 165 <hr>
 166 <div class="refsect2">
 167 <a name="STUN-AGENT-MAX-UNKNOWN-ATTRIBUTES:CAPS"></a><h3>STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES</h3>
 168 <pre class="programlisting">#define STUN_AGENT_MAX_UNKNOWN_ATTRIBUTES 256
 169 </pre>
 170 <p>Maximum number of unknown attribute which can be handled in a single STUN
 171 message.</p>
 172 </div>
 173 <hr>
 174 <div class="refsect2">
 175 <a name="STUN-ATTRIBUTE-HEADER-LENGTH:CAPS"></a><h3>STUN_ATTRIBUTE_HEADER_LENGTH</h3>
 176 <pre class="programlisting">#define STUN_ATTRIBUTE_HEADER_LENGTH STUN_ATTRIBUTE_VALUE_POS
 177 </pre>
 178 <p>Length of a single STUN attribute header (in bytes).</p>
 179 </div>
 180 <hr>
 181 <div class="refsect2">
 182 <a name="STUN-ATTRIBUTE-LENGTH-LEN:CAPS"></a><h3>STUN_ATTRIBUTE_LENGTH_LEN</h3>
 183 <pre class="programlisting">#define STUN_ATTRIBUTE_LENGTH_LEN 2
 184 </pre>
 185 <p>Length of the length field of a STUN attribute (in bytes).</p>
 186 </div>
 187 <hr>
 188 <div class="refsect2">
 189 <a name="STUN-ATTRIBUTE-LENGTH-POS:CAPS"></a><h3>STUN_ATTRIBUTE_LENGTH_POS</h3>
 190 <pre class="programlisting">#define             STUN_ATTRIBUTE_LENGTH_POS</pre>
 191 <p>Offset of the length field of a STUN attribute (in bytes).</p>
 192 </div>
 193 <hr>
 194 <div class="refsect2">
 195 <a name="STUN-ATTRIBUTE-TYPE-LEN:CAPS"></a><h3>STUN_ATTRIBUTE_TYPE_LEN</h3>
 196 <pre class="programlisting">#define STUN_ATTRIBUTE_TYPE_LEN 2
 197 </pre>
 198 <p>Length of the type field of a STUN attribute (in bytes).</p>
 199 </div>
 200 <hr>
 201 <div class="refsect2">
 202 <a name="STUN-ATTRIBUTE-TYPE-POS:CAPS"></a><h3>STUN_ATTRIBUTE_TYPE_POS</h3>
 203 <pre class="programlisting">#define STUN_ATTRIBUTE_TYPE_POS 0
 204 </pre>
 205 <p>Offset of the type field of a STUN attribute (in bytes).</p>
 206 </div>
 207 <hr>
 208 <div class="refsect2">
 209 <a name="STUN-ATTRIBUTE-VALUE-POS:CAPS"></a><h3>STUN_ATTRIBUTE_VALUE_POS</h3>
 210 <pre class="programlisting">#define             STUN_ATTRIBUTE_VALUE_POS</pre>
 211 <p>Offset of the value field of a STUN attribute (in bytes).</p>
 212 </div>
 213 <hr>
 214 <div class="refsect2">
 215 <a name="STUN-ID-LEN:CAPS"></a><h3>STUN_ID_LEN</h3>
 216 <pre class="programlisting">#define STUN_ID_LEN 16
 217 </pre>
 218 <p>Length of the ID field of a STUN message (in bytes).</p>
 219 </div>
 220 <hr>
 221 <div class="refsect2">
 222 <a name="STUN-MAGIC-COOKIE:CAPS"></a><h3>STUN_MAGIC_COOKIE</h3>
 223 <pre class="programlisting">#define STUN_MAGIC_COOKIE 0x2112A442
 224 </pre>
 225 <p>Magic cookie value used to identify STUN messages.</p>
 226 </div>
 227 <hr>
 228 <div class="refsect2">
 229 <a name="STUN-MAX-MESSAGE-SIZE:CAPS"></a><h3>STUN_MAX_MESSAGE_SIZE</h3>
 230 <pre class="programlisting">#define STUN_MAX_MESSAGE_SIZE 65552
 231 </pre>
 232 <p>The Maximum size of a STUN message</p>
 233 </div>
 234 <hr>
 235 <div class="refsect2">
 236 <a name="STUN-MAX-MESSAGE-SIZE-IPV4:CAPS"></a><h3>STUN_MAX_MESSAGE_SIZE_IPV4</h3>
 237 <pre class="programlisting">#define STUN_MAX_MESSAGE_SIZE_IPV4 576
 238 </pre>
 239 <p>Maximum size of a STUN message sent over IPv4 (in bytes).</p>
 240 </div>
 241 <hr>
 242 <div class="refsect2">
 243 <a name="STUN-MAX-MESSAGE-SIZE-IPV6:CAPS"></a><h3>STUN_MAX_MESSAGE_SIZE_IPV6</h3>
 244 <pre class="programlisting">#define STUN_MAX_MESSAGE_SIZE_IPV6 1280
 245 </pre>
 246 <p>Maximum size of a STUN message sent over IPv6 (in bytes).</p>
 247 </div>
 248 <hr>
 249 <div class="refsect2">
 250 <a name="STUN-MESSAGE-ATTRIBUTES-POS:CAPS"></a><h3>STUN_MESSAGE_ATTRIBUTES_POS</h3>
 251 <pre class="programlisting">#define             STUN_MESSAGE_ATTRIBUTES_POS</pre>
 252 <p>Offset of the attributes of a STUN message (in bytes).</p>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="STUN-MESSAGE-HEADER-LENGTH:CAPS"></a><h3>STUN_MESSAGE_HEADER_LENGTH</h3>
 257 <pre class="programlisting">#define STUN_MESSAGE_HEADER_LENGTH STUN_MESSAGE_ATTRIBUTES_POS
 258 </pre>
 259 <p>Total length of a STUN message header (in bytes).</p>
 260 </div>
 261 <hr>
 262 <div class="refsect2">
 263 <a name="STUN-MESSAGE-LENGTH-LEN:CAPS"></a><h3>STUN_MESSAGE_LENGTH_LEN</h3>
 264 <pre class="programlisting">#define STUN_MESSAGE_LENGTH_LEN 2
 265 </pre>
 266 <p>Length of the length field of a STUN message (in bytes).</p>
 267 </div>
 268 <hr>
 269 <div class="refsect2">
 270 <a name="STUN-MESSAGE-LENGTH-POS:CAPS"></a><h3>STUN_MESSAGE_LENGTH_POS</h3>
 271 <pre class="programlisting">#define             STUN_MESSAGE_LENGTH_POS</pre>
 272 <p>Offset of the length field of a STUN message (in bytes).</p>
 273 </div>
 274 <hr>
 275 <div class="refsect2">
 276 <a name="STUN-MESSAGE-TRANS-ID-LEN:CAPS"></a><h3>STUN_MESSAGE_TRANS_ID_LEN</h3>
 277 <pre class="programlisting">#define STUN_MESSAGE_TRANS_ID_LEN 16
 278 </pre>
 279 <p>Length of the transaction ID field of a STUN message (in bytes).</p>
 280 </div>
 281 <hr>
 282 <div class="refsect2">
 283 <a name="STUN-MESSAGE-TRANS-ID-POS:CAPS"></a><h3>STUN_MESSAGE_TRANS_ID_POS</h3>
 284 <pre class="programlisting">#define             STUN_MESSAGE_TRANS_ID_POS</pre>
 285 <p>Offset of the transaction ID field of a STUN message (in bytes).</p>
 286 </div>
 287 <hr>
 288 <div class="refsect2">
 289 <a name="STUN-MESSAGE-TYPE-LEN:CAPS"></a><h3>STUN_MESSAGE_TYPE_LEN</h3>
 290 <pre class="programlisting">#define STUN_MESSAGE_TYPE_LEN 2
 291 </pre>
 292 <p>Length of the type field of a STUN message (in bytes).</p>
 293 </div>
 294 <hr>
 295 <div class="refsect2">
 296 <a name="STUN-MESSAGE-TYPE-POS:CAPS"></a><h3>STUN_MESSAGE_TYPE_POS</h3>
 297 <pre class="programlisting">#define STUN_MESSAGE_TYPE_POS 0
 298 </pre>
 299 <p>Offset of the type field of a STUN message (in bytes).</p>
 300 </div>
 301 <hr>
 302 <div class="refsect2">
 303 <a name="TURN-MAGIC-COOKIE:CAPS"></a><h3>TURN_MAGIC_COOKIE</h3>
 304 <pre class="programlisting">#define TURN_MAGIC_COOKIE 0x72c64bc6
 305 </pre>
 306 <p>Magic cookie value used to identify TURN messages.</p>
 307 </div>
 308 </div>
 309 </div>
 310 <div class="footer">
 311 <hr>Generated by GTK-Doc V1.29</div>
 312 </body>
 313 </html>