2 * Copyright (C) <2005,2006> Wim Taymans <wim@fluendo.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/rtsp/gstrtspdefs.h>
49 #include <gst/rtsp/gstrtspurl.h>
50 #include <gst/rtsp/gstrtspmessage.h>
54 typedef struct _GstRTSPConnection GstRTSPConnection;
59 * Opaque RTSP connection object.
61 struct _GstRTSPConnection
64 /* URL for the connection */
67 /* connection state */
73 gint cseq; /* sequence number */
74 gchar session_id[512]; /* session id */
75 gint timeout; /* session timeout in seconds */
76 GTimer *timer; /* timeout timer */
79 GstRTSPAuthMethod auth_method;
82 GHashTable *auth_params;
85 /* opening/closing a connection */
86 GstRTSPResult gst_rtsp_connection_create (GstRTSPUrl *url, GstRTSPConnection **conn);
87 GstRTSPResult gst_rtsp_connection_accept (gint sock, GstRTSPConnection **conn);
88 GstRTSPResult gst_rtsp_connection_connect (GstRTSPConnection *conn, GTimeVal *timeout);
89 GstRTSPResult gst_rtsp_connection_close (GstRTSPConnection *conn);
90 GstRTSPResult gst_rtsp_connection_free (GstRTSPConnection *conn);
92 /* sending/receiving raw bytes */
93 GstRTSPResult gst_rtsp_connection_read (GstRTSPConnection * conn, guint8 * data,
94 guint size, GTimeVal * timeout);
95 GstRTSPResult gst_rtsp_connection_write (GstRTSPConnection * conn, const guint8 * data,
96 guint size, GTimeVal * timeout);
98 /* sending/receiving messages */
99 GstRTSPResult gst_rtsp_connection_send (GstRTSPConnection *conn, GstRTSPMessage *message,
101 GstRTSPResult gst_rtsp_connection_receive (GstRTSPConnection *conn, GstRTSPMessage *message,
104 /* status management */
105 GstRTSPResult gst_rtsp_connection_poll (GstRTSPConnection *conn, GstRTSPEvent events,
106 GstRTSPEvent *revents, GTimeVal *timeout);
108 /* reset the timeout */
109 GstRTSPResult gst_rtsp_connection_next_timeout (GstRTSPConnection *conn, GTimeVal *timeout);
110 GstRTSPResult gst_rtsp_connection_reset_timeout (GstRTSPConnection *conn);
113 GstRTSPResult gst_rtsp_connection_flush (GstRTSPConnection *conn, gboolean flush);
115 /* configure authentication data */
116 GstRTSPResult gst_rtsp_connection_set_auth (GstRTSPConnection *conn, GstRTSPAuthMethod method,
117 const gchar *user, const gchar *pass);
119 void gst_rtsp_connection_set_auth_param (GstRTSPConnection *conn,
122 void gst_rtsp_connection_clear_auth_params (GstRTSPConnection *conn);
125 GstRTSPResult gst_rtsp_connection_set_qos_dscp (GstRTSPConnection *conn,
129 const gchar * gst_rtsp_connection_get_ip (const GstRTSPConnection *conn);
136 * Opaque RTSP channel object that can be used for asynchronous RTSP
139 typedef struct _GstRTSPChannel GstRTSPChannel;
142 * GstRTSPChannelFuncs:
143 * @message_received: callback when a message was received
144 * @message_sent: callback when a message was sent
145 * @closed: callback when the connection is closed
146 * @error: callback when an error occured
148 * Callback functions from a #GstRTSPChannel.
151 GstRTSPResult (*message_received) (GstRTSPChannel *channel, GstRTSPMessage *message,
153 GstRTSPResult (*message_sent) (GstRTSPChannel *channel, guint cseq,
155 GstRTSPResult (*closed) (GstRTSPChannel *channel, gpointer user_data);
156 GstRTSPResult (*error) (GstRTSPChannel *channel, GstRTSPResult result,
158 } GstRTSPChannelFuncs;
160 GstRTSPChannel * gst_rtsp_channel_new (GstRTSPConnection *conn,
161 GstRTSPChannelFuncs *funcs,
163 GDestroyNotify notify);
164 void gst_rtsp_channel_unref (GstRTSPChannel *channel);
166 guint gst_rtsp_channel_attach (GstRTSPChannel *channel,
167 GMainContext *context);
169 guint gst_rtsp_channel_queue_message (GstRTSPChannel *channel,
170 GstRTSPMessage *message);
175 #endif /* __GST_RTSP_CONNECTION_H__ */