docs/libs/html/gst-rtsp-server-GstRTSPContext.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: GstRTSPContext</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="GstRTSPClient.html" title="GstRTSPClient">
  10 <link rel="next" href="GstRTSPMountPoints.html" title="GstRTSPMountPoints">
  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-GstRTSPContext.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="GstRTSPClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="GstRTSPMountPoints.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-GstRTSPContext"></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-GstRTSPContext.top_of_page"></a>GstRTSPContext</span></h2>
  30 <p>GstRTSPContext — A client request context</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-GstRTSPContext.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-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="returnvalue">GstRTSPContext</span></a> *
  45 </td>
  46 <td class="function_name">
  47 <a class="link" href="gst-rtsp-server-GstRTSPContext.html#gst-rtsp-context-get-current" title="gst_rtsp_context_get_current ()">gst_rtsp_context_get_current</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <span class="returnvalue">void</span>
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="gst-rtsp-server-GstRTSPContext.html#gst-rtsp-context-push-current" title="gst_rtsp_context_push_current ()">gst_rtsp_context_push_current</a> <span class="c_punctuation">()</span>
  56 </td>
  57 </tr>
  58 <tr>
  59 <td class="function_type">
  60 <span class="returnvalue">void</span>
  61 </td>
  62 <td class="function_name">
  63 <a class="link" href="gst-rtsp-server-GstRTSPContext.html#gst-rtsp-context-pop-current" title="gst_rtsp_context_pop_current ()">gst_rtsp_context_pop_current</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 </tbody>
  67 </table></div>
  68 </div>
  69 <div class="refsect1">
  70 <a name="gst-rtsp-server-GstRTSPContext.other"></a><h2>Types and Values</h2>
  71 <div class="informaltable"><table width="100%" border="0">
  72 <colgroup>
  73 <col width="150px" class="name">
  74 <col class="description">
  75 </colgroup>
  76 <tbody><tr>
  77 <td class="datatype_keyword">struct</td>
  78 <td class="function_name"><a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext">GstRTSPContext</a></td>
  79 </tr></tbody>
  80 </table></div>
  81 </div>
  82 <div class="refsect1">
  83 <a name="gst-rtsp-server-GstRTSPContext.description"></a><h2>Description</h2>
  84 <p>Last reviewed on 2013-07-11 (1.0.0)</p>
  85 </div>
  86 <div class="refsect1">
  87 <a name="gst-rtsp-server-GstRTSPContext.functions_details"></a><h2>Functions</h2>
  88 <div class="refsect2">
  89 <a name="gst-rtsp-context-get-current"></a><h3>gst_rtsp_context_get_current ()</h3>
  90 <pre class="programlisting"><a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="returnvalue">GstRTSPContext</span></a> *
  91 gst_rtsp_context_get_current (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  92 <p>Get the current <a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a>. This object is retrieved from the
  93 current thread that is handling the request for a client.</p>
  94 <div class="refsect3">
  95 <a name="id-1.2.3.6.2.5"></a><h4>Returns</h4>
  96 <p> a <a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a></p>
  97 <p></p>
  98 </div>
  99 </div>
 100 <hr>
 101 <div class="refsect2">
 102 <a name="gst-rtsp-context-push-current"></a><h3>gst_rtsp_context_push_current ()</h3>
 103 <pre class="programlisting"><span class="returnvalue">void</span>
 104 gst_rtsp_context_push_current (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a> *ctx</code></em>);</pre>
 105 <p>Pushes <em class="parameter"><code>ctx</code></em>
 106  onto the context stack. The current
 107 context can then be received using <a class="link" href="gst-rtsp-server-GstRTSPContext.html#gst-rtsp-context-get-current" title="gst_rtsp_context_get_current ()"><code class="function">gst_rtsp_context_get_current()</code></a>.</p>
 108 <div class="refsect3">
 109 <a name="id-1.2.3.6.3.5"></a><h4>Parameters</h4>
 110 <div class="informaltable"><table width="100%" border="0">
 111 <colgroup>
 112 <col width="150px" class="parameters_name">
 113 <col class="parameters_description">
 114 <col width="200px" class="parameters_annotations">
 115 </colgroup>
 116 <tbody><tr>
 117 <td class="parameter_name"><p>ctx</p></td>
 118 <td class="parameter_description"><p>a #<a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a></p></td>
 119 <td class="parameter_annotations"> </td>
 120 </tr></tbody>
 121 </table></div>
 122 </div>
 123 </div>
 124 <hr>
 125 <div class="refsect2">
 126 <a name="gst-rtsp-context-pop-current"></a><h3>gst_rtsp_context_pop_current ()</h3>
 127 <pre class="programlisting"><span class="returnvalue">void</span>
 128 gst_rtsp_context_pop_current (<em class="parameter"><code><a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a> *ctx</code></em>);</pre>
 129 <p>Pops <em class="parameter"><code>ctx</code></em>
 130  off the context stack (verifying that <em class="parameter"><code>ctx</code></em>
 131
 132 is on the top of the stack).</p>
 133 <div class="refsect3">
 134 <a name="id-1.2.3.6.4.5"></a><h4>Parameters</h4>
 135 <div class="informaltable"><table width="100%" border="0">
 136 <colgroup>
 137 <col width="150px" class="parameters_name">
 138 <col class="parameters_description">
 139 <col width="200px" class="parameters_annotations">
 140 </colgroup>
 141 <tbody><tr>
 142 <td class="parameter_name"><p>ctx</p></td>
 143 <td class="parameter_description"><p>a <a class="link" href="gst-rtsp-server-GstRTSPContext.html#GstRTSPContext" title="struct GstRTSPContext"><span class="type">GstRTSPContext</span></a></p></td>
 144 <td class="parameter_annotations"> </td>
 145 </tr></tbody>
 146 </table></div>
 147 </div>
 148 </div>
 149 </div>
 150 <div class="refsect1">
 151 <a name="gst-rtsp-server-GstRTSPContext.other_details"></a><h2>Types and Values</h2>
 152 <div class="refsect2">
 153 <a name="GstRTSPContext"></a><h3>struct GstRTSPContext</h3>
 154 <pre class="programlisting">struct GstRTSPContext {
 155   GstRTSPServer       *server;
 156   GstRTSPConnection   *conn;
 157   GstRTSPClient       *client;
 158   GstRTSPMessage      *request;
 159   GstRTSPUrl          *uri;
 160   GstRTSPMethod        method;
 161   GstRTSPAuth         *auth;
 162   GstRTSPToken        *token;
 163   GstRTSPSession      *session;
 164   GstRTSPSessionMedia *sessmedia;
 165   GstRTSPMediaFactory *factory;
 166   GstRTSPMedia        *media;
 167   GstRTSPStream       *stream;
 168   GstRTSPMessage      *response;
 169 };
 170 </pre>
 171 <p>Information passed around containing the context of a request.</p>
 172 <div class="refsect3">
 173 <a name="id-1.2.3.7.2.5"></a><h4>Members</h4>
 174 <div class="informaltable"><table width="100%" border="0">
 175 <colgroup>
 176 <col width="300px" class="struct_members_name">
 177 <col class="struct_members_description">
 178 <col width="200px" class="struct_members_annotations">
 179 </colgroup>
 180 <tbody>
 181 <tr>
 182 <td class="struct_member_name"><p><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a> *<em class="structfield"><code><a name="GstRTSPContext.server"></a>server</code></em>;</p></td>
 183 <td class="struct_member_description"><p>the server</p></td>
 184 <td class="struct_member_annotations"> </td>
 185 </tr>
 186 <tr>
 187 <td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspconnection.html#GstRTSPConnection"><span class="type">GstRTSPConnection</span></a> *<em class="structfield"><code><a name="GstRTSPContext.conn"></a>conn</code></em>;</p></td>
 188 <td class="struct_member_description"><p>the connection</p></td>
 189 <td class="struct_member_annotations"> </td>
 190 </tr>
 191 <tr>
 192 <td class="struct_member_name"><p><a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a> *<em class="structfield"><code><a name="GstRTSPContext.client"></a>client</code></em>;</p></td>
 193 <td class="struct_member_description"><p>the client</p></td>
 194 <td class="struct_member_annotations"> </td>
 195 </tr>
 196 <tr>
 197 <td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspmessage.html#GstRTSPMessage"><span class="type">GstRTSPMessage</span></a> *<em class="structfield"><code><a name="GstRTSPContext.request"></a>request</code></em>;</p></td>
 198 <td class="struct_member_description"><p>the complete request</p></td>
 199 <td class="struct_member_annotations"> </td>
 200 </tr>
 201 <tr>
 202 <td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspurl.html#GstRTSPUrl"><span class="type">GstRTSPUrl</span></a> *<em class="structfield"><code><a name="GstRTSPContext.uri"></a>uri</code></em>;</p></td>
 203 <td class="struct_member_description"><p>the complete url parsed from <em class="parameter"><code>request</code></em>
 204 </p></td>
 205 <td class="struct_member_annotations"> </td>
 206 </tr>
 207 <tr>
 208 <td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspdefs.html#GstRTSPMethod"><span class="type">GstRTSPMethod</span></a> <em class="structfield"><code><a name="GstRTSPContext.method"></a>method</code></em>;</p></td>
 209 <td class="struct_member_description"><p>the parsed method of <em class="parameter"><code>uri</code></em>
 210 </p></td>
 211 <td class="struct_member_annotations"> </td>
 212 </tr>
 213 <tr>
 214 <td class="struct_member_name"><p><a class="link" href="GstRTSPAuth.html" title="GstRTSPAuth"><span class="type">GstRTSPAuth</span></a> *<em class="structfield"><code><a name="GstRTSPContext.auth"></a>auth</code></em>;</p></td>
 215 <td class="struct_member_description"><p>the current auth object or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 216 <td class="struct_member_annotations"> </td>
 217 </tr>
 218 <tr>
 219 <td class="struct_member_name"><p><a class="link" href="gst-rtsp-server-GstRTSPToken.html#GstRTSPToken" title="struct GstRTSPToken"><span class="type">GstRTSPToken</span></a> *<em class="structfield"><code><a name="GstRTSPContext.token"></a>token</code></em>;</p></td>
 220 <td class="struct_member_description"><p>authorisation token</p></td>
 221 <td class="struct_member_annotations"> </td>
 222 </tr>
 223 <tr>
 224 <td class="struct_member_name"><p><a class="link" href="GstRTSPSession.html" title="GstRTSPSession"><span class="type">GstRTSPSession</span></a> *<em class="structfield"><code><a name="GstRTSPContext.session"></a>session</code></em>;</p></td>
 225 <td class="struct_member_description"><p>the session, can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 226 <td class="struct_member_annotations"> </td>
 227 </tr>
 228 <tr>
 229 <td class="struct_member_name"><p><a class="link" href="gst-rtsp-server-GstRTSPSessionMedia.html#GstRTSPSessionMedia" title="struct GstRTSPSessionMedia"><span class="type">GstRTSPSessionMedia</span></a> *<em class="structfield"><code><a name="GstRTSPContext.sessmedia"></a>sessmedia</code></em>;</p></td>
 230 <td class="struct_member_description"><p>the session media for the url can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 231 <td class="struct_member_annotations"> </td>
 232 </tr>
 233 <tr>
 234 <td class="struct_member_name"><p><a class="link" href="GstRTSPMediaFactory.html" title="GstRTSPMediaFactory"><span class="type">GstRTSPMediaFactory</span></a> *<em class="structfield"><code><a name="GstRTSPContext.factory"></a>factory</code></em>;</p></td>
 235 <td class="struct_member_description"><p>the media factory for the url, can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 236 <td class="struct_member_annotations"> </td>
 237 </tr>
 238 <tr>
 239 <td class="struct_member_name"><p><a class="link" href="GstRTSPMedia.html" title="GstRTSPMedia"><span class="type">GstRTSPMedia</span></a> *<em class="structfield"><code><a name="GstRTSPContext.media"></a>media</code></em>;</p></td>
 240 <td class="struct_member_description"><p>the media for the url can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 241 <td class="struct_member_annotations"> </td>
 242 </tr>
 243 <tr>
 244 <td class="struct_member_name"><p><a class="link" href="GstRTSPStream.html" title="GstRTSPStream"><span class="type">GstRTSPStream</span></a> *<em class="structfield"><code><a name="GstRTSPContext.stream"></a>stream</code></em>;</p></td>
 245 <td class="struct_member_description"><p>the stream for the url can be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
 246 <td class="struct_member_annotations"> </td>
 247 </tr>
 248 <tr>
 249 <td class="struct_member_name"><p><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstrtspmessage.html#GstRTSPMessage"><span class="type">GstRTSPMessage</span></a> *<em class="structfield"><code><a name="GstRTSPContext.response"></a>response</code></em>;</p></td>
 250 <td class="struct_member_description"><p>the response</p></td>
 251 <td class="struct_member_annotations"> </td>
 252 </tr>
 253 </tbody>
 254 </table></div>
 255 </div>
 256 </div>
 257 </div>
 258 <div class="refsect1">
 259 <a name="gst-rtsp-server-GstRTSPContext.see-also"></a><h2>See Also</h2>
 260 <p><a class="link" href="GstRTSPServer.html" title="GstRTSPServer"><span class="type">GstRTSPServer</span></a>, <a class="link" href="GstRTSPClient.html" title="GstRTSPClient"><span class="type">GstRTSPClient</span></a></p>
 261 </div>
 262 </div>
 263 <div class="footer">
 264 <hr>
 265           Generated by GTK-Doc V1.21</div>
 266 </body>
 267 </html>