rtspconnection: GstRTSPWatch func for tunnel GET response
[platform/upstream/gstreamer.git] / gst-libs / gst / rtsp / gstrtspconnection.h
index 56a6432..71686e0 100644 (file)
@@ -1,5 +1,5 @@
 /* GStreamer
- * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.com>
+ * Copyright (C) <2005,2009> Wim Taymans <wim.taymans@gmail.com>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
@@ -13,8 +13,8 @@
  *
  * You should have received a copy of the GNU Library General Public
  * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
  */
 /*
  * Unless otherwise indicated, Source Code is licensed under MIT license.
 
 #include <glib.h>
 
+#include <gst/gstconfig.h>
 #include <gst/rtsp/gstrtspdefs.h>
 #include <gst/rtsp/gstrtspurl.h>
 #include <gst/rtsp/gstrtspmessage.h>
+#include <gio/gio.h>
 
 G_BEGIN_DECLS
 
@@ -59,50 +61,84 @@ G_BEGIN_DECLS
 typedef struct _GstRTSPConnection GstRTSPConnection;
 
 /* opening/closing a connection */
-GstRTSPResult      gst_rtsp_connection_create        (GstRTSPUrl *url, GstRTSPConnection **conn);
-GstRTSPResult      gst_rtsp_connection_accept        (gint sock, GstRTSPConnection **conn);
-GstRTSPResult      gst_rtsp_connection_connect       (GstRTSPConnection *conn, GTimeVal *timeout);
-GstRTSPResult      gst_rtsp_connection_close         (GstRTSPConnection *conn);
-GstRTSPResult      gst_rtsp_connection_free          (GstRTSPConnection *conn);
+GstRTSPResult      gst_rtsp_connection_create         (const GstRTSPUrl *url, GstRTSPConnection **conn);
+GstRTSPResult      gst_rtsp_connection_create_from_socket (GSocket * socket,
+                                                       const gchar * ip,
+                                                       guint16 port,
+                                                       const gchar * initial_buffer,
+                                                       GstRTSPConnection ** conn);
+GstRTSPResult      gst_rtsp_connection_accept         (GSocket *socket, GstRTSPConnection **conn, GCancellable *cancellable);
+GstRTSPResult      gst_rtsp_connection_connect        (GstRTSPConnection *conn, GTimeVal *timeout);
+GstRTSPResult      gst_rtsp_connection_close          (GstRTSPConnection *conn);
+GstRTSPResult      gst_rtsp_connection_free           (GstRTSPConnection *conn);
+
+/* TLS connections */
+GTlsConnection *     gst_rtsp_connection_get_tls                  (GstRTSPConnection * conn, GError ** error);
+gboolean             gst_rtsp_connection_set_tls_validation_flags (GstRTSPConnection * conn, GTlsCertificateFlags flags);
+GTlsCertificateFlags gst_rtsp_connection_get_tls_validation_flags (GstRTSPConnection * conn);
+void                 gst_rtsp_connection_set_tls_database (GstRTSPConnection * conn, GTlsDatabase * database);
+GTlsDatabase *       gst_rtsp_connection_get_tls_database (GstRTSPConnection * conn);
 
 /* sending/receiving raw bytes */
-GstRTSPResult      gst_rtsp_connection_read          (GstRTSPConnection * conn, guint8 * data,
-                                                      guint size, GTimeVal * timeout);
-GstRTSPResult      gst_rtsp_connection_write         (GstRTSPConnection * conn, const guint8 * data, 
-                                                     guint size, GTimeVal * timeout);
+GstRTSPResult      gst_rtsp_connection_read           (GstRTSPConnection * conn, guint8 * data,
+                                                       guint size, GTimeVal * timeout);
+GstRTSPResult      gst_rtsp_connection_write          (GstRTSPConnection * conn, const guint8 * data,
+                                                       guint size, GTimeVal * timeout);
 
 /* sending/receiving messages */
-GstRTSPResult      gst_rtsp_connection_send          (GstRTSPConnection *conn, GstRTSPMessage *message,
-                                                      GTimeVal *timeout);
-GstRTSPResult      gst_rtsp_connection_receive       (GstRTSPConnection *conn, GstRTSPMessage *message,
-                                                      GTimeVal *timeout);
+GstRTSPResult      gst_rtsp_connection_send           (GstRTSPConnection *conn, GstRTSPMessage *message,
+                                                       GTimeVal *timeout);
+GstRTSPResult      gst_rtsp_connection_receive        (GstRTSPConnection *conn, GstRTSPMessage *message,
+                                                       GTimeVal *timeout);
 
 /* status management */
-GstRTSPResult      gst_rtsp_connection_poll          (GstRTSPConnection *conn, GstRTSPEvent events,
-                                                      GstRTSPEvent *revents, GTimeVal *timeout);
+GstRTSPResult      gst_rtsp_connection_poll           (GstRTSPConnection *conn, GstRTSPEvent events,
+                                                       GstRTSPEvent *revents, GTimeVal *timeout);
 
 /* reset the timeout */
-GstRTSPResult      gst_rtsp_connection_next_timeout  (GstRTSPConnection *conn, GTimeVal *timeout);
-GstRTSPResult      gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
+GstRTSPResult      gst_rtsp_connection_next_timeout   (GstRTSPConnection *conn, GTimeVal *timeout);
+GstRTSPResult      gst_rtsp_connection_reset_timeout  (GstRTSPConnection *conn);
 
 /* flushing state */
-GstRTSPResult      gst_rtsp_connection_flush         (GstRTSPConnection *conn, gboolean flush);
+GstRTSPResult      gst_rtsp_connection_flush          (GstRTSPConnection *conn, gboolean flush);
+
+/* HTTP proxy support */
+GstRTSPResult      gst_rtsp_connection_set_proxy      (GstRTSPConnection *conn,
+                                                       const gchar *host, guint port);
 
 /* configure authentication data */
-GstRTSPResult      gst_rtsp_connection_set_auth      (GstRTSPConnection *conn, GstRTSPAuthMethod method,
-                                                      const gchar *user, const gchar *pass);
+GstRTSPResult      gst_rtsp_connection_set_auth       (GstRTSPConnection *conn, GstRTSPAuthMethod method,
+                                                       const gchar *user, const gchar *pass);
 
 void               gst_rtsp_connection_set_auth_param    (GstRTSPConnection *conn,
-                                                         const gchar * param,
-                                                         const gchar *value);
+                                                          const gchar * param,
+                                                          const gchar *value);
 void               gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
 
 /* configure DSCP */
-GstRTSPResult      gst_rtsp_connection_set_qos_dscp  (GstRTSPConnection *conn,
-                                                      guint qos_dscp);
+GstRTSPResult      gst_rtsp_connection_set_qos_dscp   (GstRTSPConnection *conn,
+                                                       guint qos_dscp);
 
 /* accessors */
-const gchar *      gst_rtsp_connection_get_ip        (const GstRTSPConnection *conn);
+GstRTSPUrl *       gst_rtsp_connection_get_url        (const GstRTSPConnection *conn);
+const gchar *      gst_rtsp_connection_get_ip         (const GstRTSPConnection *conn);
+void               gst_rtsp_connection_set_ip         (GstRTSPConnection *conn, const gchar *ip);
+
+GSocket *          gst_rtsp_connection_get_read_socket  (const GstRTSPConnection *conn);
+GSocket *          gst_rtsp_connection_get_write_socket (const GstRTSPConnection *conn);
+
+void               gst_rtsp_connection_set_http_mode  (GstRTSPConnection *conn,
+                                                       gboolean enable);
+
+/* tunneling */
+void               gst_rtsp_connection_set_tunneled   (GstRTSPConnection *conn, gboolean tunneled);
+gboolean           gst_rtsp_connection_is_tunneled    (const GstRTSPConnection *conn);
+
+const gchar *      gst_rtsp_connection_get_tunnelid   (const GstRTSPConnection *conn);
+GstRTSPResult      gst_rtsp_connection_do_tunnel      (GstRTSPConnection *conn, GstRTSPConnection *conn2);
+
+void               gst_rtsp_connection_set_remember_session_id (GstRTSPConnection *conn, gboolean remember);
+gboolean           gst_rtsp_connection_get_remember_session_id (GstRTSPConnection *conn);
 
 /* async IO */
 
@@ -120,33 +156,64 @@ typedef struct _GstRTSPWatch GstRTSPWatch;
  * @message_sent: callback when a message was sent
  * @closed: callback when the connection is closed
  * @error: callback when an error occured
+ * @tunnel_start: a client started a tunneled connection. The tunnelid of the
+ *   connection must be saved.
+ * @tunnel_complete: a client finished a tunneled connection. In this callback
+ *   you usually pair the tunnelid of this connection with the saved one using
+ *   gst_rtsp_connection_do_tunnel().
+ * @error_full: callback when an error occured with more information than
+ *   the @error callback.
+ * @tunnel_lost: callback when the post connection of a tunnel is closed.
+ * @tunnel_http_response: callback when an HTTP response to the GET request
+ *   is about to be sent for a tunneled connection. The response can be
+ *   modified in the callback. Since 1.4.
  *
  * Callback functions from a #GstRTSPWatch.
  */
 typedef struct {
-  GstRTSPResult (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
-                                     gpointer user_data);
-  GstRTSPResult (*message_sent)     (GstRTSPWatch *watch, guint cseq, 
-                                     gpointer user_data);
-  GstRTSPResult (*closed)           (GstRTSPWatch *watch, gpointer user_data);
-  GstRTSPResult (*error)            (GstRTSPWatch *watch, GstRTSPResult result,
-                                     gpointer user_data);
+  GstRTSPResult     (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
+                                         gpointer user_data);
+  GstRTSPResult     (*message_sent)     (GstRTSPWatch *watch, guint id,
+                                         gpointer user_data);
+  GstRTSPResult     (*closed)           (GstRTSPWatch *watch, gpointer user_data);
+  GstRTSPResult     (*error)            (GstRTSPWatch *watch, GstRTSPResult result,
+                                         gpointer user_data);
+  GstRTSPStatusCode (*tunnel_start)     (GstRTSPWatch *watch, gpointer user_data);
+  GstRTSPResult     (*tunnel_complete)  (GstRTSPWatch *watch, gpointer user_data);
+  GstRTSPResult     (*error_full)       (GstRTSPWatch *watch, GstRTSPResult result,
+                                         GstRTSPMessage *message, guint id,
+                                         gpointer user_data);
+  GstRTSPResult     (*tunnel_lost)      (GstRTSPWatch *watch, gpointer user_data);
+  GstRTSPResult     (*tunnel_http_response) (GstRTSPWatch *watch,
+                                             GstRTSPMessage *request,
+                                             GstRTSPMessage *response,
+                                             gpointer user_data);
 
   /*< private >*/
-  gpointer _gst_reserved[GST_PADDING];
+  gpointer _gst_reserved[GST_PADDING-1];
 } GstRTSPWatchFuncs;
 
 GstRTSPWatch *     gst_rtsp_watch_new                (GstRTSPConnection *conn,
                                                       GstRTSPWatchFuncs *funcs,
-                                                     gpointer user_data,
-                                                     GDestroyNotify notify);
+                                                      gpointer user_data,
+                                                      GDestroyNotify notify);
+void               gst_rtsp_watch_reset              (GstRTSPWatch *watch);
 void               gst_rtsp_watch_unref              (GstRTSPWatch *watch);
 
 guint              gst_rtsp_watch_attach             (GstRTSPWatch *watch,
                                                       GMainContext *context);
 
-guint              gst_rtsp_watch_queue_message      (GstRTSPWatch *watch,
-                                                      GstRTSPMessage *message);
+void               gst_rtsp_watch_set_send_backlog  (GstRTSPWatch *watch,
+                                                     gsize bytes, guint messages);
+void               gst_rtsp_watch_get_send_backlog  (GstRTSPWatch *watch,
+                                                     gsize *bytes, guint *messages);
+
+GstRTSPResult      gst_rtsp_watch_write_data         (GstRTSPWatch *watch,
+                                                      const guint8 *data,
+                                                      guint size, guint *id);
+GstRTSPResult      gst_rtsp_watch_send_message       (GstRTSPWatch *watch,
+                                                      GstRTSPMessage *message,
+                                                      guint *id);
 
 G_END_DECLS