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        (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 /* sending/receiving raw bytes */
  69 GstRTSPResult      gst_rtsp_connection_read          (GstRTSPConnection * conn, guint8 * data,
  70                                                       guint size, GTimeVal * timeout);
  71 GstRTSPResult      gst_rtsp_connection_write         (GstRTSPConnection * conn, const guint8 * data,
  72                                                       guint size, GTimeVal * timeout);
  73
  74 /* sending/receiving messages */
  75 GstRTSPResult      gst_rtsp_connection_send          (GstRTSPConnection *conn, GstRTSPMessage *message,
  76                                                       GTimeVal *timeout);
  77 GstRTSPResult      gst_rtsp_connection_receive       (GstRTSPConnection *conn, GstRTSPMessage *message,
  78                                                       GTimeVal *timeout);
  79
  80 /* status management */
  81 GstRTSPResult      gst_rtsp_connection_poll          (GstRTSPConnection *conn, GstRTSPEvent events,
  82                                                       GstRTSPEvent *revents, GTimeVal *timeout);
  83
  84 /* reset the timeout */
  85 GstRTSPResult      gst_rtsp_connection_next_timeout  (GstRTSPConnection *conn, GTimeVal *timeout);
  86 GstRTSPResult      gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
  87
  88 /* flushing state */
  89 GstRTSPResult      gst_rtsp_connection_flush         (GstRTSPConnection *conn, gboolean flush);
  90
  91 /* configure authentication data */
  92 GstRTSPResult      gst_rtsp_connection_set_auth      (GstRTSPConnection *conn, GstRTSPAuthMethod method,
  93                                                       const gchar *user, const gchar *pass);
  94
  95 void               gst_rtsp_connection_set_auth_param    (GstRTSPConnection *conn,
  96                                                           const gchar * param,
  97                                                           const gchar *value);
  98 void               gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
  99
 100 /* configure DSCP */
 101 GstRTSPResult      gst_rtsp_connection_set_qos_dscp  (GstRTSPConnection *conn,
 102                                                       guint qos_dscp);
 103
 104 /* accessors */
 105 GstRTSPUrl *       gst_rtsp_connection_get_url       (const GstRTSPConnection *conn);
 106 const gchar *      gst_rtsp_connection_get_ip        (const GstRTSPConnection *conn);
 107
 108 /* async IO */
 109
 110 /**
 111  * GstRTSPWatch:
 112  *
 113  * Opaque RTSP watch object that can be used for asynchronous RTSP
 114  * operations.
 115  */
 116 typedef struct _GstRTSPWatch GstRTSPWatch;
 117
 118 /**
 119  * GstRTSPWatchFuncs:
 120  * @message_received: callback when a message was received
 121  * @message_sent: callback when a message was sent
 122  * @closed: callback when the connection is closed
 123  * @error: callback when an error occured
 124  *
 125  * Callback functions from a #GstRTSPWatch.
 126  */
 127 typedef struct {
 128   GstRTSPResult (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
 129                                      gpointer user_data);
 130   GstRTSPResult (*message_sent)     (GstRTSPWatch *watch, guint cseq,
 131                                      gpointer user_data);
 132   GstRTSPResult (*closed)           (GstRTSPWatch *watch, gpointer user_data);
 133   GstRTSPResult (*error)            (GstRTSPWatch *watch, GstRTSPResult result,
 134                                      gpointer user_data);
 135
 136   /*< private >*/
 137   gpointer _gst_reserved[GST_PADDING];
 138 } GstRTSPWatchFuncs;
 139
 140 GstRTSPWatch *     gst_rtsp_watch_new                (GstRTSPConnection *conn,
 141                                                       GstRTSPWatchFuncs *funcs,
 142                                                       gpointer user_data,
 143                                                       GDestroyNotify notify);
 144 void               gst_rtsp_watch_unref              (GstRTSPWatch *watch);
 145
 146 guint              gst_rtsp_watch_attach             (GstRTSPWatch *watch,
 147                                                       GMainContext *context);
 148
 149 guint              gst_rtsp_watch_queue_message      (GstRTSPWatch *watch,
 150                                                       GstRTSPMessage *message);
 151
 152 G_END_DECLS
 153
 154 #endif /* __GST_RTSP_CONNECTION_H__ */