1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GStreamer RTSP Server Reference Manual: GstRTSPPermissions</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="gst-rtsp-server-GstRTSPToken.html" title="GstRTSPToken">
10 <link rel="next" href="gst-rtsp-server-GstRTSPParams.html" title="GstRTSPParams">
11 <meta name="generator" content="GTK-Doc V1.21 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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-GstRTSPPermissions.description" class="shortcut">Description</a></span>
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="gst-rtsp-server-GstRTSPToken.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="gst-rtsp-server-GstRTSPParams.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25 <div class="refentry">
26 <a name="gst-rtsp-server-GstRTSPPermissions"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
29 <h2><span class="refentrytitle"><a name="gst-rtsp-server-GstRTSPPermissions.top_of_page"></a>GstRTSPPermissions</span></h2>
30 <p>GstRTSPPermissions — Roles and associated permissions</p>
32 <td class="gallery_image" valign="top" align="right"></td>
34 <div class="refsect1">
35 <a name="gst-rtsp-server-GstRTSPPermissions.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
43 <td class="function_type">
44 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
46 <td class="function_name">
47 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-new" title="gst_rtsp_permissions_new ()">gst_rtsp_permissions_new</a> <span class="c_punctuation">()</span>
51 <td class="function_type">
52 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
54 <td class="function_name">
55 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-ref" title="gst_rtsp_permissions_ref ()">gst_rtsp_permissions_ref</a> <span class="c_punctuation">()</span>
59 <td class="function_type">
60 <span class="returnvalue">void</span>
62 <td class="function_name">
63 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-unref" title="gst_rtsp_permissions_unref ()">gst_rtsp_permissions_unref</a> <span class="c_punctuation">()</span>
67 <td class="function_type">
68 <span class="returnvalue">void</span>
70 <td class="function_name">
71 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-add-role" title="gst_rtsp_permissions_add_role ()">gst_rtsp_permissions_add_role</a> <span class="c_punctuation">()</span>
75 <td class="function_type">
76 <span class="returnvalue">void</span>
78 <td class="function_name">
79 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-add-role-valist" title="gst_rtsp_permissions_add_role_valist ()">gst_rtsp_permissions_add_role_valist</a> <span class="c_punctuation">()</span>
83 <td class="function_type">
84 <span class="returnvalue">void</span>
86 <td class="function_name">
87 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-remove-role" title="gst_rtsp_permissions_remove_role ()">gst_rtsp_permissions_remove_role</a> <span class="c_punctuation">()</span>
91 <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> *
93 <td class="function_name">
94 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-get-role" title="gst_rtsp_permissions_get_role ()">gst_rtsp_permissions_get_role</a> <span class="c_punctuation">()</span>
98 <td class="function_type">
99 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
101 <td class="function_name">
102 <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-is-allowed" title="gst_rtsp_permissions_is_allowed ()">gst_rtsp_permissions_is_allowed</a> <span class="c_punctuation">()</span>
108 <div class="refsect1">
109 <a name="gst-rtsp-server-GstRTSPPermissions.other"></a><h2>Types and Values</h2>
110 <div class="informaltable"><table width="100%" border="0">
112 <col width="150px" class="name">
113 <col class="description">
116 <td class="datatype_keyword">struct</td>
117 <td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions">GstRTSPPermissions</a></td>
121 <div class="refsect1">
122 <a name="gst-rtsp-server-GstRTSPPermissions.description"></a><h2>Description</h2>
123 <p>The <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> object contains an array of roles and associated
124 permissions. The roles are represented with a string and the permissions with
125 a generic <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a>.</p>
126 <p>The permissions are deliberately kept generic. The possible values of the
127 roles and <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="type">GstStructure</span></a> keys and values are only determined by the <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a>
128 object that performs the checks on the permissions and the current
129 <a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a>.</p>
130 <p>As a convenience function, <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#gst-rtsp-permissions-is-allowed" title="gst_rtsp_permissions_is_allowed ()"><code class="function">gst_rtsp_permissions_is_allowed()</code></a> can be used to
131 check if the permissions contains a role that contains the boolean value
132 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for the the given key.</p>
133 <p>Last reviewed on 2013-07-15 (1.0.0)</p>
135 <div class="refsect1">
136 <a name="gst-rtsp-server-GstRTSPPermissions.functions_details"></a><h2>Functions</h2>
137 <div class="refsect2">
138 <a name="gst-rtsp-permissions-new"></a><h3>gst_rtsp_permissions_new ()</h3>
139 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
140 gst_rtsp_permissions_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
141 <p>Create a new empty Authorization permissions.</p>
142 <div class="refsect3">
143 <a name="id-1.2.18.6.2.5"></a><h4>Returns</h4>
144 <p> a new empty authorization permissions. </p>
145 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
149 <div class="refsect2">
150 <a name="gst-rtsp-permissions-ref"></a><h3>gst_rtsp_permissions_ref ()</h3>
151 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="returnvalue">GstRTSPPermissions</span></a> *
152 gst_rtsp_permissions_ref (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>);</pre>
153 <p>Increase the refcount of this permissions.</p>
154 <div class="refsect3">
155 <a name="id-1.2.18.6.3.5"></a><h4>Parameters</h4>
156 <div class="informaltable"><table width="100%" border="0">
158 <col width="150px" class="parameters_name">
159 <col class="parameters_description">
160 <col width="200px" class="parameters_annotations">
163 <td class="parameter_name"><p>permissions</p></td>
164 <td class="parameter_description"><p>The permissions to refcount</p></td>
165 <td class="parameter_annotations"> </td>
169 <div class="refsect3">
170 <a name="id-1.2.18.6.3.6"></a><h4>Returns</h4>
171 <p> <em class="parameter"><code>permissions</code></em>
172 (for convenience when doing assignments). </p>
173 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
177 <div class="refsect2">
178 <a name="gst-rtsp-permissions-unref"></a><h3>gst_rtsp_permissions_unref ()</h3>
179 <pre class="programlisting"><span class="returnvalue">void</span>
180 gst_rtsp_permissions_unref (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>);</pre>
181 <p>Decrease the refcount of an permissions, freeing it if the refcount reaches 0.</p>
182 <div class="refsect3">
183 <a name="id-1.2.18.6.4.5"></a><h4>Parameters</h4>
184 <div class="informaltable"><table width="100%" border="0">
186 <col width="150px" class="parameters_name">
187 <col class="parameters_description">
188 <col width="200px" class="parameters_annotations">
191 <td class="parameter_name"><p>permissions</p></td>
192 <td class="parameter_description"><p> the permissions to refcount. </p></td>
193 <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>
199 <div class="refsect2">
200 <a name="gst-rtsp-permissions-add-role"></a><h3>gst_rtsp_permissions_add_role ()</h3>
201 <pre class="programlisting"><span class="returnvalue">void</span>
202 gst_rtsp_permissions_add_role (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
203 <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> *role</code></em>,
204 <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> *fieldname</code></em>,
205 <em class="parameter"><code>...</code></em>);</pre>
206 <p>Add a new <em class="parameter"><code>role</code></em>
207 to <em class="parameter"><code>permissions</code></em>
208 with the given variables. The fields
209 are the same layout as <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>
210 <div class="refsect3">
211 <a name="id-1.2.18.6.5.5"></a><h4>Parameters</h4>
212 <div class="informaltable"><table width="100%" border="0">
214 <col width="150px" class="parameters_name">
215 <col class="parameters_description">
216 <col width="200px" class="parameters_annotations">
220 <td class="parameter_name"><p>permissions</p></td>
221 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
222 <td class="parameter_annotations"> </td>
225 <td class="parameter_name"><p>role</p></td>
226 <td class="parameter_description"><p>a role</p></td>
227 <td class="parameter_annotations"> </td>
230 <td class="parameter_name"><p>fieldname</p></td>
231 <td class="parameter_description"><p>the first field name</p></td>
232 <td class="parameter_annotations"> </td>
235 <td class="parameter_name"><p>...</p></td>
236 <td class="parameter_description"><p>additional arguments</p></td>
237 <td class="parameter_annotations"> </td>
244 <div class="refsect2">
245 <a name="gst-rtsp-permissions-add-role-valist"></a><h3>gst_rtsp_permissions_add_role_valist ()</h3>
246 <pre class="programlisting"><span class="returnvalue">void</span>
247 gst_rtsp_permissions_add_role_valist (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
248 <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> *role</code></em>,
249 <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> *fieldname</code></em>,
250 <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
251 <p>Add a new <em class="parameter"><code>role</code></em>
252 to <em class="parameter"><code>permissions</code></em>
253 with the given variables. Structure fields
254 are set according to the varargs in a manner 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>
255 <div class="refsect3">
256 <a name="id-1.2.18.6.6.5"></a><h4>Parameters</h4>
257 <div class="informaltable"><table width="100%" border="0">
259 <col width="150px" class="parameters_name">
260 <col class="parameters_description">
261 <col width="200px" class="parameters_annotations">
265 <td class="parameter_name"><p>permissions</p></td>
266 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
267 <td class="parameter_annotations"> </td>
270 <td class="parameter_name"><p>role</p></td>
271 <td class="parameter_description"><p>a role</p></td>
272 <td class="parameter_annotations"> </td>
275 <td class="parameter_name"><p>fieldname</p></td>
276 <td class="parameter_description"><p>the first field name</p></td>
277 <td class="parameter_annotations"> </td>
280 <td class="parameter_name"><p>var_args</p></td>
281 <td class="parameter_description"><p>additional fields to add</p></td>
282 <td class="parameter_annotations"> </td>
289 <div class="refsect2">
290 <a name="gst-rtsp-permissions-remove-role"></a><h3>gst_rtsp_permissions_remove_role ()</h3>
291 <pre class="programlisting"><span class="returnvalue">void</span>
292 gst_rtsp_permissions_remove_role (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
293 <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> *role</code></em>);</pre>
294 <p>Remove all permissions for <em class="parameter"><code>role</code></em>
295 in <em class="parameter"><code>permissions</code></em>
297 <div class="refsect3">
298 <a name="id-1.2.18.6.7.5"></a><h4>Parameters</h4>
299 <div class="informaltable"><table width="100%" border="0">
301 <col width="150px" class="parameters_name">
302 <col class="parameters_description">
303 <col width="200px" class="parameters_annotations">
307 <td class="parameter_name"><p>permissions</p></td>
308 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
309 <td class="parameter_annotations"> </td>
312 <td class="parameter_name"><p>role</p></td>
313 <td class="parameter_description"><p>a role</p></td>
314 <td class="parameter_annotations"> </td>
321 <div class="refsect2">
322 <a name="gst-rtsp-permissions-get-role"></a><h3>gst_rtsp_permissions_get_role ()</h3>
323 <pre class="programlisting">const <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstStructure.html"><span class="returnvalue">GstStructure</span></a> *
324 gst_rtsp_permissions_get_role (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
325 <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> *role</code></em>);</pre>
326 <p>Get all permissions for <em class="parameter"><code>role</code></em>
327 in <em class="parameter"><code>permissions</code></em>
329 <div class="refsect3">
330 <a name="id-1.2.18.6.8.5"></a><h4>Parameters</h4>
331 <div class="informaltable"><table width="100%" border="0">
333 <col width="150px" class="parameters_name">
334 <col class="parameters_description">
335 <col width="200px" class="parameters_annotations">
339 <td class="parameter_name"><p>permissions</p></td>
340 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
341 <td class="parameter_annotations"> </td>
344 <td class="parameter_name"><p>role</p></td>
345 <td class="parameter_description"><p>a role</p></td>
346 <td class="parameter_annotations"> </td>
351 <div class="refsect3">
352 <a name="id-1.2.18.6.8.6"></a><h4>Returns</h4>
353 <p> the structure with permissions for <em class="parameter"><code>role</code></em>
355 remains valid for as long as <em class="parameter"><code>permissions</code></em>
357 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
361 <div class="refsect2">
362 <a name="gst-rtsp-permissions-is-allowed"></a><h3>gst_rtsp_permissions_is_allowed ()</h3>
363 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
364 gst_rtsp_permissions_is_allowed (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a> *permissions</code></em>,
365 <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> *role</code></em>,
366 <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> *permission</code></em>);</pre>
367 <p>Check if <em class="parameter"><code>role</code></em>
368 in <em class="parameter"><code>permissions</code></em>
369 is given permission for <em class="parameter"><code>permission</code></em>
371 <div class="refsect3">
372 <a name="id-1.2.18.6.9.5"></a><h4>Parameters</h4>
373 <div class="informaltable"><table width="100%" border="0">
375 <col width="150px" class="parameters_name">
376 <col class="parameters_description">
377 <col width="200px" class="parameters_annotations">
381 <td class="parameter_name"><p>permissions</p></td>
382 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPPermissions.html#GstRTSPPermissions" title="struct GstRTSPPermissions"><span class="type">GstRTSPPermissions</span></a></p></td>
383 <td class="parameter_annotations"> </td>
386 <td class="parameter_name"><p>role</p></td>
387 <td class="parameter_description"><p>a role</p></td>
388 <td class="parameter_annotations"> </td>
391 <td class="parameter_name"><p>permission</p></td>
392 <td class="parameter_description"><p>a permission</p></td>
393 <td class="parameter_annotations"> </td>
398 <div class="refsect3">
399 <a name="id-1.2.18.6.9.6"></a><h4>Returns</h4>
400 <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>role</code></em>
401 is allowed <em class="parameter"><code>permission</code></em>
407 <div class="refsect1">
408 <a name="gst-rtsp-server-GstRTSPPermissions.other_details"></a><h2>Types and Values</h2>
409 <div class="refsect2">
410 <a name="GstRTSPPermissions"></a><h3>struct GstRTSPPermissions</h3>
411 <pre class="programlisting">struct GstRTSPPermissions {
412 GstMiniObject mini_object;
415 <p>The opaque permissions structure. It is used to define the permissions
416 of objects in different roles.</p>
419 <div class="refsect1">
420 <a name="gst-rtsp-server-GstRTSPPermissions.see-also"></a><h2>See Also</h2>
421 <p><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a>, <a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a></p>
426 Generated by GTK-Doc V1.21</div>