gst-libs/gst/rtsp/gstrtspconnection.h

   1 /* GStreamer
   2  * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19 /*
  20  * Unless otherwise indicated, Source Code is licensed under MIT license.
  21  * See further explanation attached in License Statement (distributed in the file
  22  * LICENSE).
  23  *
  24  * Permission is hereby granted, free of charge, to any person obtaining a copy of
  25  * this software and associated documentation files (the "Software"), to deal in
  26  * the Software without restriction, including without limitation the rights to
  27  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
  28  * of the Software, and to permit persons to whom the Software is furnished to do
  29  * so, subject to the following conditions:
  30  *
  31  * The above copyright notice and this permission notice shall be included in all
  32  * copies or substantial portions of the Software.
  33  *
  34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  35  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  36  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  37  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  38  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  39  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  40  * SOFTWARE.
  41  */
  42
  43 #ifndef __GST_RTSP_CONNECTION_H__
  44 #define __GST_RTSP_CONNECTION_H__
  45
  46 #include <glib.h>
  47
  48 #include <gst/rtsp/gstrtspdefs.h>
  49 #include <gst/rtsp/gstrtspurl.h>
  50 #include <gst/rtsp/gstrtspmessage.h>
  51
  52 G_BEGIN_DECLS
  53
  54 /**
  55  * GstRTSPConnection:
  56  *
  57  * Opaque RTSP connection object.
  58  */
  59 typedef struct _GstRTSPConnection GstRTSPConnection;
  60
  61 /* opening/closing a connection */
  62 GstRTSPResult      gst_rtsp_connection_create        (const GstRTSPUrl *url, GstRTSPConnection **conn);
  63 GstRTSPResult      gst_rtsp_connection_accept        (gint sock, GstRTSPConnection **conn);
  64 GstRTSPResult      gst_rtsp_connection_connect       (GstRTSPConnection *conn, GTimeVal *timeout);
  65 GstRTSPResult      gst_rtsp_connection_close         (GstRTSPConnection *conn);
  66 GstRTSPResult      gst_rtsp_connection_free          (GstRTSPConnection *conn);
  67
  68
  69 /* sending/receiving raw bytes */
  70 GstRTSPResult      gst_rtsp_connection_read          (GstRTSPConnection * conn, guint8 * data,
  71                                                       guint size, GTimeVal * timeout);
  72 GstRTSPResult      gst_rtsp_connection_write         (GstRTSPConnection * conn, const guint8 * data,
  73                                                       guint size, GTimeVal * timeout);
  74
  75 /* sending/receiving messages */
  76 GstRTSPResult      gst_rtsp_connection_send          (GstRTSPConnection *conn, GstRTSPMessage *message,
  77                                                       GTimeVal *timeout);
  78 GstRTSPResult      gst_rtsp_connection_receive       (GstRTSPConnection *conn, GstRTSPMessage *message,
  79                                                       GTimeVal *timeout);
  80
  81 /* status management */
  82 GstRTSPResult      gst_rtsp_connection_poll          (GstRTSPConnection *conn, GstRTSPEvent events,
  83                                                       GstRTSPEvent *revents, GTimeVal *timeout);
  84
  85 /* reset the timeout */
  86 GstRTSPResult      gst_rtsp_connection_next_timeout  (GstRTSPConnection *conn, GTimeVal *timeout);
  87 GstRTSPResult      gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
  88
  89 /* flushing state */
  90 GstRTSPResult      gst_rtsp_connection_flush         (GstRTSPConnection *conn, gboolean flush);
  91
  92 /* configure authentication data */
  93 GstRTSPResult      gst_rtsp_connection_set_auth      (GstRTSPConnection *conn, GstRTSPAuthMethod method,
  94                                                       const gchar *user, const gchar *pass);
  95
  96 void               gst_rtsp_connection_set_auth_param    (GstRTSPConnection *conn,
  97                                                           const gchar * param,
  98                                                           const gchar *value);
  99 void               gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
 100
 101 /* configure DSCP */
 102 GstRTSPResult      gst_rtsp_connection_set_qos_dscp  (GstRTSPConnection *conn,
 103                                                       guint qos_dscp);
 104
 105 /* accessors */
 106 GstRTSPUrl *       gst_rtsp_connection_get_url       (const GstRTSPConnection *conn);
 107 const gchar *      gst_rtsp_connection_get_ip        (const GstRTSPConnection *conn);
 108 void               gst_rtsp_connection_set_ip        (GstRTSPConnection *conn, const gchar *ip);
 109
 110 /* tunneling */
 111 void               gst_rtsp_connection_set_tunneled  (GstRTSPConnection *conn, gboolean tunneled);
 112 gboolean           gst_rtsp_connection_is_tunneled   (const GstRTSPConnection *conn);
 113
 114 const gchar *      gst_rtsp_connection_get_tunnelid  (const GstRTSPConnection *conn);
 115 GstRTSPResult      gst_rtsp_connection_do_tunnel     (GstRTSPConnection *conn, GstRTSPConnection *conn2);
 116
 117 /* async IO */
 118
 119 /**
 120  * GstRTSPWatch:
 121  *
 122  * Opaque RTSP watch object that can be used for asynchronous RTSP
 123  * operations.
 124  */
 125 typedef struct _GstRTSPWatch GstRTSPWatch;
 126
 127 /**
 128  * GstRTSPWatchFuncs:
 129  * @message_received: callback when a message was received
 130  * @message_sent: callback when a message was sent
 131  * @closed: callback when the connection is closed
 132  * @error: callback when an error occured
 133  * @tunnel_start: a client started a tunneled connection. The tunnelid of the
 134  *   connection must be saved.
 135  * @tunnel_complete: a client finished a tunneled connection. In this callback
 136  *   you usually pair the tunnelid of this connection with the saved one using
 137  *   gst_rtsp_connection_do_tunnel().
 138  *
 139  * Callback functions from a #GstRTSPWatch.
 140  *
 141  * Since: 0.10.23
 142  */
 143 typedef struct {
 144   GstRTSPResult     (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
 145                                          gpointer user_data);
 146   GstRTSPResult     (*message_sent)     (GstRTSPWatch *watch, guint cseq,
 147                                          gpointer user_data);
 148   GstRTSPResult     (*closed)           (GstRTSPWatch *watch, gpointer user_data);
 149   GstRTSPResult     (*error)            (GstRTSPWatch *watch, GstRTSPResult result,
 150                                          gpointer user_data);
 151   GstRTSPStatusCode (*tunnel_start)     (GstRTSPWatch *watch, gpointer user_data);
 152   GstRTSPResult     (*tunnel_complete)  (GstRTSPWatch *watch, gpointer user_data);
 153
 154   /*< private >*/
 155   gpointer _gst_reserved[GST_PADDING];
 156 } GstRTSPWatchFuncs;
 157
 158 GstRTSPWatch *     gst_rtsp_watch_new                (GstRTSPConnection *conn,
 159                                                       GstRTSPWatchFuncs *funcs,
 160                                                       gpointer user_data,
 161                                                       GDestroyNotify notify);
 162 void               gst_rtsp_watch_reset              (GstRTSPWatch *watch);
 163 void               gst_rtsp_watch_unref              (GstRTSPWatch *watch);
 164
 165 guint              gst_rtsp_watch_attach             (GstRTSPWatch *watch,
 166                                                       GMainContext *context);
 167
 168 guint              gst_rtsp_watch_queue_message      (GstRTSPWatch *watch,
 169                                                       GstRTSPMessage *message);
 170
 171 G_END_DECLS
 172
 173 #endif /* __GST_RTSP_CONNECTION_H__ */