docs/libs/html/gst-rtsp-server-GstRTSPToken.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>GStreamer RTSP Server Reference Manual: GstRTSPToken</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="GStreamer RTSP Server Reference Manual">
   8 <link rel="up" href="ch01.html" title="">
   9 <link rel="prev" href="GstRTSPAuth.html" title="GstRTSPAuth">
  10 <link rel="next" href="gst-rtsp-server-GstRTSPPermissions.html" title="GstRTSPPermissions">
  11 <meta name="generator" content="GTK-Doc V1.21 (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="#gst-rtsp-server-GstRTSPToken.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22 <td><a accesskey="p" href="GstRTSPAuth.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="gst-rtsp-server-GstRTSPPermissions.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="gst-rtsp-server-GstRTSPToken"></a><div class="titlepage"></div>
  27 <div class="refnamediv"><table width="100%"><tr>
  28 <td valign="top">
  29 <h2><span class="refentrytitle"><a name="gst-rtsp-server-GstRTSPToken.top_of_page"></a>GstRTSPToken</span></h2>
  30 <p>GstRTSPToken — Roles and permissions for a client</p>
  31 </td>
  32 <td class="gallery_image" valign="top" align="right"></td>
  33 </tr></table></div>
  34 <div class="refsect1">
  35 <a name="gst-rtsp-server-GstRTSPToken.functions"></a><h2>Functions</h2>
  36 <div class="informaltable"><table width="100%" border="0">
  37 <colgroup>
  38 <col width="150px" class="functions_return">
  39 <col class="functions_name">
  40 </colgroup>
  41 <tbody>
  42 <tr>
  43 <td class="function_type">
  44 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-new-empty" title="gst_rtsp_token_new_empty ()">gst_rtsp_token_new_empty</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-new" title="gst_rtsp_token_new ()">gst_rtsp_token_new</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-new-valist" title="gst_rtsp_token_new_valist ()">gst_rtsp_token_new_valist</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">
  68 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-ref" title="gst_rtsp_token_ref ()">gst_rtsp_token_ref</a> <span class="c_punctuation">()</span>
  72 </td>
  73 </tr>
  74 <tr>
  75 <td class="function_type">
  76 <span class="returnvalue">void</span>
  77 </td>
  78 <td class="function_name">
  79 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-unref" title="gst_rtsp_token_unref ()">gst_rtsp_token_unref</a> <span class="c_punctuation">()</span>
  80 </td>
  81 </tr>
  82 <tr>
  83 <td class="function_type">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="returnvalue">GstStructure</span></a> *
  84 </td>
  85 <td class="function_name">
  86 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-get-structure" title="gst_rtsp_token_get_structure ()">gst_rtsp_token_get_structure</a> <span class="c_punctuation">()</span>
  87 </td>
  88 </tr>
  89 <tr>
  90 <td class="function_type">
  91 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="returnvalue">GstStructure</span></a> *
  92 </td>
  93 <td class="function_name">
  94 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-writable-structure" title="gst_rtsp_token_writable_structure ()">gst_rtsp_token_writable_structure</a> <span class="c_punctuation">()</span>
  95 </td>
  96 </tr>
  97 <tr>
  98 <td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
  99 </td>
 100 <td class="function_name">
 101 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-get-string" title="gst_rtsp_token_get_string ()">gst_rtsp_token_get_string</a> <span class="c_punctuation">()</span>
 102 </td>
 103 </tr>
 104 <tr>
 105 <td class="function_type">
 106 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 107 </td>
 108 <td class="function_name">
 109 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#gst-rtsp-token-is-allowed" title="gst_rtsp_token_is_allowed ()">gst_rtsp_token_is_allowed</a> <span class="c_punctuation">()</span>
 110 </td>
 111 </tr>
 112 </tbody>
 113 </table></div>
 114 </div>
 115 <div class="refsect1">
 116 <a name="gst-rtsp-server-GstRTSPToken.other"></a><h2>Types and Values</h2>
 117 <div class="informaltable"><table width="100%" border="0">
 118 <colgroup>
 119 <col width="150px" class="name">
 120 <col class="description">
 121 </colgroup>
 122 <tbody><tr>
 123 <td class="datatype_keyword">struct</td>
 124 <td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken">GstRTSPToken</a></td>
 125 </tr></tbody>
 126 </table></div>
 127 </div>
 128 <div class="refsect1">
 129 <a name="gst-rtsp-server-GstRTSPToken.description"></a><h2>Description</h2>
 130 <p>A <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> contains the permissions and roles of the user
 131 performing the current request. A token is usually created when a user is
 132 authenticated by the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> object and is then placed as the current
 133 token for the current request.</p>
 134 <p><a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> can use the token and its contents to check authorization for
 135 various operations by comparing the token to the <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> of the
 136 object.</p>
 137 <p>The accepted values of the token are entirely defined by the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a>
 138 object that implements the security policy.</p>
 139 <p>Last reviewed on 2013-07-15 (1.0.0)</p>
 140 </div>
 141 <div class="refsect1">
 142 <a name="gst-rtsp-server-GstRTSPToken.functions_details"></a><h2>Functions</h2>
 143 <div class="refsect2">
 144 <a name="gst-rtsp-token-new-empty"></a><h3>gst_rtsp_token_new_empty ()</h3>
 145 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
 146 gst_rtsp_token_new_empty (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 147 <p>Create a new empty Authorization token.</p>
 148 <div class="refsect3">
 149 <a name="id-1.2.17.6.2.5"></a><h4>Returns</h4>
 150 <p> a new empty authorization token. </p>
 151 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 152 </div>
 153 </div>
 154 <hr>
 155 <div class="refsect2">
 156 <a name="gst-rtsp-token-new"></a><h3>gst_rtsp_token_new ()</h3>
 157 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
 158 gst_rtsp_token_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *firstfield</code></em>,
 159                     <em class="parameter"><code>...</code></em>);</pre>
 160 <p>Create a new Authorization token with the given fieldnames and values.
 161 Arguments are given similar to <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html#gst-structure-new"><code class="function">gst_structure_new()</code></a>.</p>
 162 <div class="refsect3">
 163 <a name="id-1.2.17.6.3.5"></a><h4>Parameters</h4>
 164 <div class="informaltable"><table width="100%" border="0">
 165 <colgroup>
 166 <col width="150px" class="parameters_name">
 167 <col class="parameters_description">
 168 <col width="200px" class="parameters_annotations">
 169 </colgroup>
 170 <tbody>
 171 <tr>
 172 <td class="parameter_name"><p>firstfield</p></td>
 173 <td class="parameter_description"><p>the first fieldname</p></td>
 174 <td class="parameter_annotations"> </td>
 175 </tr>
 176 <tr>
 177 <td class="parameter_name"><p>...</p></td>
 178 <td class="parameter_description"><p>additional arguments</p></td>
 179 <td class="parameter_annotations"> </td>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 </div>
 184 <div class="refsect3">
 185 <a name="id-1.2.17.6.3.6"></a><h4>Returns</h4>
 186 <p> a new authorization token. </p>
 187 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 188 </div>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="gst-rtsp-token-new-valist"></a><h3>gst_rtsp_token_new_valist ()</h3>
 193 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
 194 gst_rtsp_token_new_valist (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *firstfield</code></em>,
 195                            <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
 196 <p>Create a new Authorization token with the given fieldnames and values.
 197 Arguments are given similar to <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html#gst-structure-new-valist"><code class="function">gst_structure_new_valist()</code></a>.</p>
 198 <div class="refsect3">
 199 <a name="id-1.2.17.6.4.5"></a><h4>Parameters</h4>
 200 <div class="informaltable"><table width="100%" border="0">
 201 <colgroup>
 202 <col width="150px" class="parameters_name">
 203 <col class="parameters_description">
 204 <col width="200px" class="parameters_annotations">
 205 </colgroup>
 206 <tbody>
 207 <tr>
 208 <td class="parameter_name"><p>firstfield</p></td>
 209 <td class="parameter_description"><p>the first fieldname</p></td>
 210 <td class="parameter_annotations"> </td>
 211 </tr>
 212 <tr>
 213 <td class="parameter_name"><p>var_args</p></td>
 214 <td class="parameter_description"><p>additional arguments</p></td>
 215 <td class="parameter_annotations"> </td>
 216 </tr>
 217 </tbody>
 218 </table></div>
 219 </div>
 220 <div class="refsect3">
 221 <a name="id-1.2.17.6.4.6"></a><h4>Returns</h4>
 222 <p> a new authorization token. </p>
 223 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 224 </div>
 225 </div>
 226 <hr>
 227 <div class="refsect2">
 228 <a name="gst-rtsp-token-ref"></a><h3>gst_rtsp_token_ref ()</h3>
 229 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="returnvalue">GstRTSPToken</span></a> *
 230 gst_rtsp_token_ref (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>);</pre>
 231 <p>Increase the refcount of this token.</p>
 232 <div class="refsect3">
 233 <a name="id-1.2.17.6.5.5"></a><h4>Parameters</h4>
 234 <div class="informaltable"><table width="100%" border="0">
 235 <colgroup>
 236 <col width="150px" class="parameters_name">
 237 <col class="parameters_description">
 238 <col width="200px" class="parameters_annotations">
 239 </colgroup>
 240 <tbody><tr>
 241 <td class="parameter_name"><p>token</p></td>
 242 <td class="parameter_description"><p>The token to refcount</p></td>
 243 <td class="parameter_annotations"> </td>
 244 </tr></tbody>
 245 </table></div>
 246 </div>
 247 <div class="refsect3">
 248 <a name="id-1.2.17.6.5.6"></a><h4>Returns</h4>
 249 <p> <em class="parameter"><code>token</code></em>
 250 (for convenience when doing assignments). </p>
 251 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 252 </div>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="gst-rtsp-token-unref"></a><h3>gst_rtsp_token_unref ()</h3>
 257 <pre class="programlisting"><span class="returnvalue">void</span>
 258 gst_rtsp_token_unref (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>);</pre>
 259 <p>Decrease the refcount of an token, freeing it if the refcount reaches 0.</p>
 260 <div class="refsect3">
 261 <a name="id-1.2.17.6.6.5"></a><h4>Parameters</h4>
 262 <div class="informaltable"><table width="100%" border="0">
 263 <colgroup>
 264 <col width="150px" class="parameters_name">
 265 <col class="parameters_description">
 266 <col width="200px" class="parameters_annotations">
 267 </colgroup>
 268 <tbody><tr>
 269 <td class="parameter_name"><p>token</p></td>
 270 <td class="parameter_description"><p> the token to refcount. </p></td>
 271 <td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
 272 </tr></tbody>
 273 </table></div>
 274 </div>
 275 </div>
 276 <hr>
 277 <div class="refsect2">
 278 <a name="gst-rtsp-token-get-structure"></a><h3>gst_rtsp_token_get_structure ()</h3>
 279 <pre class="programlisting">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="returnvalue">GstStructure</span></a> *
 280 gst_rtsp_token_get_structure (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>);</pre>
 281 <p>Access the structure of the token.</p>
 282 <div class="refsect3">
 283 <a name="id-1.2.17.6.7.5"></a><h4>Parameters</h4>
 284 <div class="informaltable"><table width="100%" border="0">
 285 <colgroup>
 286 <col width="150px" class="parameters_name">
 287 <col class="parameters_description">
 288 <col width="200px" class="parameters_annotations">
 289 </colgroup>
 290 <tbody><tr>
 291 <td class="parameter_name"><p>token</p></td>
 292 <td class="parameter_description"><p>The <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a>.</p></td>
 293 <td class="parameter_annotations"> </td>
 294 </tr></tbody>
 295 </table></div>
 296 </div>
 297 <div class="refsect3">
 298 <a name="id-1.2.17.6.7.6"></a><h4>Returns</h4>
 299 <p> The structure of the token. The structure is still
 300 owned by the token, which means that you should not free it and that the
 301 pointer becomes invalid when you free the token.</p>
 302 <p>MT safe. </p>
 303 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 304 </div>
 305 </div>
 306 <hr>
 307 <div class="refsect2">
 308 <a name="gst-rtsp-token-writable-structure"></a><h3>gst_rtsp_token_writable_structure ()</h3>
 309 <pre class="programlisting"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="returnvalue">GstStructure</span></a> *
 310 gst_rtsp_token_writable_structure (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>);</pre>
 311 <p>Get a writable version of the structure.</p>
 312 <div class="refsect3">
 313 <a name="id-1.2.17.6.8.5"></a><h4>Parameters</h4>
 314 <div class="informaltable"><table width="100%" border="0">
 315 <colgroup>
 316 <col width="150px" class="parameters_name">
 317 <col class="parameters_description">
 318 <col width="200px" class="parameters_annotations">
 319 </colgroup>
 320 <tbody><tr>
 321 <td class="parameter_name"><p>token</p></td>
 322 <td class="parameter_description"><p>The <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a>.</p></td>
 323 <td class="parameter_annotations"> </td>
 324 </tr></tbody>
 325 </table></div>
 326 </div>
 327 <div class="refsect3">
 328 <a name="id-1.2.17.6.8.6"></a><h4>Returns</h4>
 329 <p> The structure of the token. The structure is still
 330 owned by the token, which means that you should not free it and that the
 331 pointer becomes invalid when you free the token. This function checks if
 332 <em class="parameter"><code>token</code></em>
 333 is writable and will never return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
 334 <p>MT safe. </p>
 335 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 336 </div>
 337 </div>
 338 <hr>
 339 <div class="refsect2">
 340 <a name="gst-rtsp-token-get-string"></a><h3>gst_rtsp_token_get_string ()</h3>
 341 <pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 342 gst_rtsp_token_get_string (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>,
 343                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field</code></em>);</pre>
 344 <p>Get the string value of <em class="parameter"><code>field</code></em>
 345  in <em class="parameter"><code>token</code></em>
 346 .</p>
 347 <div class="refsect3">
 348 <a name="id-1.2.17.6.9.5"></a><h4>Parameters</h4>
 349 <div class="informaltable"><table width="100%" border="0">
 350 <colgroup>
 351 <col width="150px" class="parameters_name">
 352 <col class="parameters_description">
 353 <col width="200px" class="parameters_annotations">
 354 </colgroup>
 355 <tbody>
 356 <tr>
 357 <td class="parameter_name"><p>token</p></td>
 358 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a></p></td>
 359 <td class="parameter_annotations"> </td>
 360 </tr>
 361 <tr>
 362 <td class="parameter_name"><p>field</p></td>
 363 <td class="parameter_description"><p>a field name</p></td>
 364 <td class="parameter_annotations"> </td>
 365 </tr>
 366 </tbody>
 367 </table></div>
 368 </div>
 369 <div class="refsect3">
 370 <a name="id-1.2.17.6.9.6"></a><h4>Returns</h4>
 371 <p> the string value of <em class="parameter"><code>field</code></em>
 372 in
 373 <em class="parameter"><code>token</code></em>
 374 or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> when <em class="parameter"><code>field</code></em>
 375 is not defined in <em class="parameter"><code>token</code></em>
 376 . The string
 377 becomes invalid when you free <em class="parameter"><code>token</code></em>
 378 . </p>
 379 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
 380 </div>
 381 </div>
 382 <hr>
 383 <div class="refsect2">
 384 <a name="gst-rtsp-token-is-allowed"></a><h3>gst_rtsp_token_is_allowed ()</h3>
 385 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 386 gst_rtsp_token_is_allowed (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *token</code></em>,
 387                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *field</code></em>);</pre>
 388 <p>Check if <em class="parameter"><code>token</code></em>
 389  has a boolean <em class="parameter"><code>field</code></em>
 390  and if it is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
 391 <div class="refsect3">
 392 <a name="id-1.2.17.6.10.5"></a><h4>Parameters</h4>
 393 <div class="informaltable"><table width="100%" border="0">
 394 <colgroup>
 395 <col width="150px" class="parameters_name">
 396 <col class="parameters_description">
 397 <col width="200px" class="parameters_annotations">
 398 </colgroup>
 399 <tbody>
 400 <tr>
 401 <td class="parameter_name"><p>token</p></td>
 402 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a></p></td>
 403 <td class="parameter_annotations"> </td>
 404 </tr>
 405 <tr>
 406 <td class="parameter_name"><p>field</p></td>
 407 <td class="parameter_description"><p>a field name</p></td>
 408 <td class="parameter_annotations"> </td>
 409 </tr>
 410 </tbody>
 411 </table></div>
 412 </div>
 413 <div class="refsect3">
 414 <a name="id-1.2.17.6.10.6"></a><h4>Returns</h4>
 415 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>token</code></em>
 416 has a boolean field named <em class="parameter"><code>field</code></em>
 417 set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
 418 <p></p>
 419 </div>
 420 </div>
 421 </div>
 422 <div class="refsect1">
 423 <a name="gst-rtsp-server-GstRTSPToken.other_details"></a><h2>Types and Values</h2>
 424 <div class="refsect2">
 425 <a name="GstRTSPToken"></a><h3>struct GstRTSPToken</h3>
 426 <pre class="programlisting">struct GstRTSPToken {
 427   GstMiniObject mini_object;
 428 };
 429 </pre>
 430 <p>An opaque object used for checking authorisations.
 431 It is generated after successful authentication.</p>
 432 </div>
 433 </div>
 434 <div class="refsect1">
 435 <a name="gst-rtsp-server-GstRTSPToken.see-also"></a><h2>See Also</h2>
 436 <p><a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a>, <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a>, <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a></p>
 437 </div>
 438 </div>
 439 <div class="footer">
 440 <hr>
 441           Generated by GTK-Doc V1.21</div>
 442 </body>
 443 </html>