mobile/docs/libs/html/gstreamer-libs-GstNetTimePacket.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>GstNetTimePacket</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer 0.10 Library Reference Manual">
   8 <link rel="up" href="gstreamer-net.html" title="GStreamer Network Classes">
   9 <link rel="prev" href="GstNetClientClock.html" title="GstNetClientClock">
  10 <link rel="next" href="GstNetTimeProvider.html" title="GstNetTimeProvider">
  11 <meta name="generator" content="GTK-Doc V1.18 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GstNetClientClock.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="gstreamer-net.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer 0.10 Library Reference Manual</th>
  21 <td><a accesskey="n" href="GstNetTimeProvider.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gstreamer-libs-GstNetTimePacket.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gstreamer-libs-GstNetTimePacket.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gstreamer-libs-GstNetTimePacket"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gstreamer-libs-GstNetTimePacket.top_of_page"></a>GstNetTimePacket</span></h2>
  34 <p>GstNetTimePacket — Helper structure to construct clock packets used
  35                     by network clocks.</p>
  36 </td>
  37 <td valign="top" align="right"></td>
  38 </tr></table></div>
  39 <div class="refsynopsisdiv">
  40 <a name="gstreamer-libs-GstNetTimePacket.synopsis"></a><h2>Synopsis</h2>
  41 <pre class="synopsis">
  42 #include &lt;gst/net/gstnet.h&gt;
  43
  44 struct              <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket">GstNetTimePacket</a>;
  45 #define             <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GST-NET-TIME-PACKET-SIZE:CAPS" title="GST_NET_TIME_PACKET_SIZE">GST_NET_TIME_PACKET_SIZE</a>
  46 <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="returnvalue">GstNetTimePacket</span></a> *  <a class="link" href="gstreamer-libs-GstNetTimePacket.html#gst-net-time-packet-new" title="gst_net_time_packet_new ()">gst_net_time_packet_new</a>             (<em class="parameter"><code>const <span class="type">guint8</span> *buffer</code></em>);
  47 <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="returnvalue">GstNetTimePacket</span></a> *  <a class="link" href="gstreamer-libs-GstNetTimePacket.html#gst-net-time-packet-receive" title="gst_net_time_packet_receive ()">gst_net_time_packet_receive</a>         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
  48                                                          <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
  49                                                          <em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);
  50 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="gstreamer-libs-GstNetTimePacket.html#gst-net-time-packet-send" title="gst_net_time_packet_send ()">gst_net_time_packet_send</a>            (<em class="parameter"><code>const <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> *packet</code></em>,
  51                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
  52                                                          <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
  53                                                          <em class="parameter"><code><span class="type">socklen_t</span> len</code></em>);
  54 <span class="returnvalue">guint8</span> *            <a class="link" href="gstreamer-libs-GstNetTimePacket.html#gst-net-time-packet-serialize" title="gst_net_time_packet_serialize ()">gst_net_time_packet_serialize</a>       (<em class="parameter"><code>const <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> *packet</code></em>);
  55 </pre>
  56 </div>
  57 <div class="refsect1">
  58 <a name="gstreamer-libs-GstNetTimePacket.description"></a><h2>Description</h2>
  59 <p>
  60 Various functions for receiving, sending an serializing <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>
  61 structures.
  62 </p>
  63 <p>
  64 Last reviewed on 2005-11-23 (0.9.5)
  65 </p>
  66 </div>
  67 <div class="refsect1">
  68 <a name="gstreamer-libs-GstNetTimePacket.details"></a><h2>Details</h2>
  69 <div class="refsect2">
  70 <a name="GstNetTimePacket"></a><h3>struct GstNetTimePacket</h3>
  71 <pre class="programlisting">struct GstNetTimePacket {
  72   GstClockTime local_time;
  73   GstClockTime remote_time;
  74 };
  75 </pre>
  76 <p>
  77 Content of a <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>.
  78 </p>
  79 <div class="variablelist"><table border="0">
  80 <col align="left" valign="top">
  81 <tbody>
  82 <tr>
  83 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <em class="structfield"><code><a name="GstNetTimePacket.local-time"></a>local_time</code></em>;</span></p></td>
  84 <td>the local time when this packet was sent</td>
  85 </tr>
  86 <tr>
  87 <td><p><span class="term"><a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <em class="structfield"><code><a name="GstNetTimePacket.remote-time"></a>remote_time</code></em>;</span></p></td>
  88 <td>the remote time observation</td>
  89 </tr>
  90 </tbody>
  91 </table></div>
  92 </div>
  93 <hr>
  94 <div class="refsect2">
  95 <a name="GST-NET-TIME-PACKET-SIZE:CAPS"></a><h3>GST_NET_TIME_PACKET_SIZE</h3>
  96 <pre class="programlisting">#define GST_NET_TIME_PACKET_SIZE 16
  97 </pre>
  98 <p>
  99 The size of the packets sent between network clocks.
 100 </p>
 101 </div>
 102 <hr>
 103 <div class="refsect2">
 104 <a name="gst-net-time-packet-new"></a><h3>gst_net_time_packet_new ()</h3>
 105 <pre class="programlisting"><a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="returnvalue">GstNetTimePacket</span></a> *  gst_net_time_packet_new             (<em class="parameter"><code>const <span class="type">guint8</span> *buffer</code></em>);</pre>
 106 <p>
 107 Creates a new <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> from a buffer received over the network. The
 108 caller is responsible for ensuring that <em class="parameter"><code>buffer</code></em> is at least
 109 <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GST-NET-TIME-PACKET-SIZE:CAPS" title="GST_NET_TIME_PACKET_SIZE"><span class="type">GST_NET_TIME_PACKET_SIZE</span></a> bytes long.
 110 </p>
 111 <p>
 112 If <em class="parameter"><code>buffer</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>, the local and remote times will be set to
 113 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html#GST-CLOCK-TIME-NONE:CAPS"><span class="type">GST_CLOCK_TIME_NONE</span></a>.
 114 </p>
 115 <p>
 116 MT safe. Caller owns return value (g_free to free).
 117 </p>
 118 <div class="variablelist"><table border="0">
 119 <col align="left" valign="top">
 120 <tbody>
 121 <tr>
 122 <td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
 123 <td>a buffer from which to construct the packet, or NULL</td>
 124 </tr>
 125 <tr>
 126 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 127 <td>The new <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>.</td>
 128 </tr>
 129 </tbody>
 130 </table></div>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="gst-net-time-packet-receive"></a><h3>gst_net_time_packet_receive ()</h3>
 135 <pre class="programlisting"><a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="returnvalue">GstNetTimePacket</span></a> *  gst_net_time_packet_receive         (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
 136                                                          <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
 137                                                          <em class="parameter"><code><span class="type">socklen_t</span> *len</code></em>);</pre>
 138 <p>
 139 Receives a <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> over a socket. Handles interrupted system calls,
 140 but otherwise returns NULL on error. See recvfrom(2) for more information on
 141 how to interpret <em class="parameter"><code>sockaddr</code></em>.
 142 </p>
 143 <p>
 144 MT safe. Caller owns return value (g_free to free).
 145 </p>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 151 <td>a file descriptor created by socket(2)</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 155 <td>a pointer to a sockaddr to hold the address of the sender</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
 159 <td>a pointer to the size of the data pointed to by <em class="parameter"><code>addr</code></em>
 160 </td>
 161 </tr>
 162 <tr>
 163 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 164 <td>The new <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>.</td>
 165 </tr>
 166 </tbody>
 167 </table></div>
 168 </div>
 169 <hr>
 170 <div class="refsect2">
 171 <a name="gst-net-time-packet-send"></a><h3>gst_net_time_packet_send ()</h3>
 172 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                gst_net_time_packet_send            (<em class="parameter"><code>const <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> *packet</code></em>,
 173                                                          <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> fd</code></em>,
 174                                                          <em class="parameter"><code><span class="type">struct sockaddr</span> *addr</code></em>,
 175                                                          <em class="parameter"><code><span class="type">socklen_t</span> len</code></em>);</pre>
 176 <p>
 177 Sends a <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> over a socket. Essentially a thin wrapper around
 178 sendto(2) and <a class="link" href="gstreamer-libs-GstNetTimePacket.html#gst-net-time-packet-serialize" title="gst_net_time_packet_serialize ()"><code class="function">gst_net_time_packet_serialize()</code></a>.
 179 </p>
 180 <p>
 181 MT safe.
 182 </p>
 183 <div class="variablelist"><table border="0">
 184 <col align="left" valign="top">
 185 <tbody>
 186 <tr>
 187 <td><p><span class="term"><em class="parameter"><code>packet</code></em> :</span></p></td>
 188 <td>the <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>
 189 </td>
 190 </tr>
 191 <tr>
 192 <td><p><span class="term"><em class="parameter"><code>fd</code></em> :</span></p></td>
 193 <td>a file descriptor created by socket(2)</td>
 194 </tr>
 195 <tr>
 196 <td><p><span class="term"><em class="parameter"><code>addr</code></em> :</span></p></td>
 197 <td>a pointer to a sockaddr to hold the address of the sender</td>
 198 </tr>
 199 <tr>
 200 <td><p><span class="term"><em class="parameter"><code>len</code></em> :</span></p></td>
 201 <td>the size of the data pointed to by <em class="parameter"><code>addr</code></em>
 202 </td>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 206 <td>The return value of sendto(2).</td>
 207 </tr>
 208 </tbody>
 209 </table></div>
 210 </div>
 211 <hr>
 212 <div class="refsect2">
 213 <a name="gst-net-time-packet-serialize"></a><h3>gst_net_time_packet_serialize ()</h3>
 214 <pre class="programlisting"><span class="returnvalue">guint8</span> *            gst_net_time_packet_serialize       (<em class="parameter"><code>const <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> *packet</code></em>);</pre>
 215 <p>
 216 Serialized a <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a> into a newly-allocated sequence of
 217 <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GST-NET-TIME-PACKET-SIZE:CAPS" title="GST_NET_TIME_PACKET_SIZE"><span class="type">GST_NET_TIME_PACKET_SIZE</span></a> bytes, in network byte order. The value returned is
 218 suitable for passing to write(2) or sendto(2) for communication over the
 219 network.
 220 </p>
 221 <p>
 222 MT safe. Caller owns return value (g_free to free).
 223 </p>
 224 <div class="variablelist"><table border="0">
 225 <col align="left" valign="top">
 226 <tbody>
 227 <tr>
 228 <td><p><span class="term"><em class="parameter"><code>packet</code></em> :</span></p></td>
 229 <td>the <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GstNetTimePacket" title="struct GstNetTimePacket"><span class="type">GstNetTimePacket</span></a>
 230 </td>
 231 </tr>
 232 <tr>
 233 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 234 <td>A newly allocated sequence of <a class="link" href="gstreamer-libs-GstNetTimePacket.html#GST-NET-TIME-PACKET-SIZE:CAPS" title="GST_NET_TIME_PACKET_SIZE"><span class="type">GST_NET_TIME_PACKET_SIZE</span></a> bytes.</td>
 235 </tr>
 236 </tbody>
 237 </table></div>
 238 </div>
 239 </div>
 240 <div class="refsect1">
 241 <a name="gstreamer-libs-GstNetTimePacket.see-also"></a><h2>See Also</h2>
 242 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstClock.html"><span class="type">GstClock</span></a>, <a class="link" href="GstNetClientClock.html" title="GstNetClientClock"><span class="type">GstNetClientClock</span></a>, <a class="link" href="GstNetTimeProvider.html" title="GstNetTimeProvider"><span class="type">GstNetTimeProvider</span></a>
 243 </div>
 244 </div>
 245 <div class="footer">
 246 <hr>
 247           Generated by GTK-Doc V1.18</div>
 248 </body>
 249 </html>