2 * Copyright (C) <2005,2009> Wim Taymans <wim.taymans@gmail.com>
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.
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.
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.
20 * Unless otherwise indicated, Source Code is licensed under MIT license.
21 * See further explanation attached in License Statement (distributed in the file
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:
31 * The above copyright notice and this permission notice shall be included in all
32 * copies or substantial portions of the Software.
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
43 #ifndef __GST_RTSP_CONNECTION_H__
44 #define __GST_RTSP_CONNECTION_H__
48 #include <gst/gstconfig.h>
49 #include <gst/rtsp/gstrtspdefs.h>
50 #include <gst/rtsp/gstrtspurl.h>
51 #include <gst/rtsp/gstrtspmessage.h>
58 * Opaque RTSP connection object.
60 typedef struct _GstRTSPConnection GstRTSPConnection;
62 /* opening/closing a connection */
63 GstRTSPResult gst_rtsp_connection_create (const GstRTSPUrl *url, GstRTSPConnection **conn);
64 GstRTSPResult gst_rtsp_connection_create_from_fd (gint fd,
67 const gchar * initial_buffer,
68 GstRTSPConnection ** conn);
69 GstRTSPResult gst_rtsp_connection_accept (gint sock, GstRTSPConnection **conn);
70 GstRTSPResult gst_rtsp_connection_connect (GstRTSPConnection *conn, GTimeVal *timeout);
71 GstRTSPResult gst_rtsp_connection_close (GstRTSPConnection *conn);
72 GstRTSPResult gst_rtsp_connection_free (GstRTSPConnection *conn);
75 /* sending/receiving raw bytes */
76 GstRTSPResult gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data,
77 guint size, GTimeVal * timeout);
78 GstRTSPResult gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
79 guint size, GTimeVal * timeout);
81 /* sending/receiving messages */
82 GstRTSPResult gst_rtsp_connection_send (GstRTSPConnection *conn, GstRTSPMessage *message,
84 GstRTSPResult gst_rtsp_connection_receive (GstRTSPConnection *conn, GstRTSPMessage *message,
87 /* status management */
88 GstRTSPResult gst_rtsp_connection_poll (GstRTSPConnection *conn, GstRTSPEvent events,
89 GstRTSPEvent *revents, GTimeVal *timeout);
91 /* reset the timeout */
92 GstRTSPResult gst_rtsp_connection_next_timeout (GstRTSPConnection *conn, GTimeVal *timeout);
93 GstRTSPResult gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
96 GstRTSPResult gst_rtsp_connection_flush (GstRTSPConnection *conn, gboolean flush);
98 /* HTTP proxy support */
99 GstRTSPResult gst_rtsp_connection_set_proxy (GstRTSPConnection *conn,
100 const gchar *host, guint port);
102 /* configure authentication data */
103 GstRTSPResult gst_rtsp_connection_set_auth (GstRTSPConnection *conn, GstRTSPAuthMethod method,
104 const gchar *user, const gchar *pass);
106 void gst_rtsp_connection_set_auth_param (GstRTSPConnection *conn,
109 void gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
112 GstRTSPResult gst_rtsp_connection_set_qos_dscp (GstRTSPConnection *conn,
116 GstRTSPUrl * gst_rtsp_connection_get_url (const GstRTSPConnection *conn);
117 const gchar * gst_rtsp_connection_get_ip (const GstRTSPConnection *conn);
118 void gst_rtsp_connection_set_ip (GstRTSPConnection *conn, const gchar *ip);
120 gint gst_rtsp_connection_get_readfd (const GstRTSPConnection *conn);
121 gint gst_rtsp_connection_get_writefd (const GstRTSPConnection *conn);
124 void gst_rtsp_connection_set_tunneled (GstRTSPConnection *conn, gboolean tunneled);
125 gboolean gst_rtsp_connection_is_tunneled (const GstRTSPConnection *conn);
127 const gchar * gst_rtsp_connection_get_tunnelid (const GstRTSPConnection *conn);
128 GstRTSPResult gst_rtsp_connection_do_tunnel (GstRTSPConnection *conn, GstRTSPConnection *conn2);
135 * Opaque RTSP watch object that can be used for asynchronous RTSP
138 typedef struct _GstRTSPWatch GstRTSPWatch;
142 * @message_received: callback when a message was received
143 * @message_sent: callback when a message was sent
144 * @closed: callback when the connection is closed
145 * @error: callback when an error occured
146 * @tunnel_start: a client started a tunneled connection. The tunnelid of the
147 * connection must be saved.
148 * @tunnel_complete: a client finished a tunneled connection. In this callback
149 * you usually pair the tunnelid of this connection with the saved one using
150 * gst_rtsp_connection_do_tunnel().
152 * Callback functions from a #GstRTSPWatch.
157 GstRTSPResult (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
159 GstRTSPResult (*message_sent) (GstRTSPWatch *watch, guint id,
161 GstRTSPResult (*closed) (GstRTSPWatch *watch, gpointer user_data);
162 GstRTSPResult (*error) (GstRTSPWatch *watch, GstRTSPResult result,
164 GstRTSPStatusCode (*tunnel_start) (GstRTSPWatch *watch, gpointer user_data);
165 GstRTSPResult (*tunnel_complete) (GstRTSPWatch *watch, gpointer user_data);
168 gpointer _gst_reserved[GST_PADDING];
171 GstRTSPWatch * gst_rtsp_watch_new (GstRTSPConnection *conn,
172 GstRTSPWatchFuncs *funcs,
174 GDestroyNotify notify);
175 void gst_rtsp_watch_reset (GstRTSPWatch *watch);
176 void gst_rtsp_watch_unref (GstRTSPWatch *watch);
178 guint gst_rtsp_watch_attach (GstRTSPWatch *watch,
179 GMainContext *context);
181 guint gst_rtsp_watch_queue_data (GstRTSPWatch * watch,
184 guint gst_rtsp_watch_queue_message (GstRTSPWatch *watch,
185 GstRTSPMessage *message);
189 #endif /* __GST_RTSP_CONNECTION_H__ */