2 * Copyright (C) 2008 Wim Taymans <wim.taymans at 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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
20 #ifndef __GST_RTSP_SERVER_H__
21 #define __GST_RTSP_SERVER_H__
27 typedef struct _GstRTSPServer GstRTSPServer;
28 typedef struct _GstRTSPServerClass GstRTSPServerClass;
29 typedef struct _GstRTSPServerPrivate GstRTSPServerPrivate;
31 #include "rtsp-session-pool.h"
32 #include "rtsp-mount-points.h"
33 #include "rtsp-client.h"
34 #include "rtsp-auth.h"
36 #define GST_TYPE_RTSP_SERVER (gst_rtsp_server_get_type ())
37 #define GST_IS_RTSP_SERVER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SERVER))
38 #define GST_IS_RTSP_SERVER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SERVER))
39 #define GST_RTSP_SERVER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
40 #define GST_RTSP_SERVER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SERVER, GstRTSPServer))
41 #define GST_RTSP_SERVER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SERVER, GstRTSPServerClass))
42 #define GST_RTSP_SERVER_CAST(obj) ((GstRTSPServer*)(obj))
43 #define GST_RTSP_SERVER_CLASS_CAST(klass) ((GstRTSPServerClass*)(klass))
48 * This object listens on a port, creates and manages the clients connected to
51 struct _GstRTSPServer {
54 GstRTSPServerPrivate *priv;
59 * @create_client: Create, configure a new GstRTSPClient
60 * object that handles the new connection on @socket. The default
61 * implementation will create a GstRTSPClient and will configure the
62 * mount-points, auth, session-pool and thread-pool on the client.
63 * @client_connected: emited when a new client connected.
65 * The RTSP server class structure
67 struct _GstRTSPServerClass {
68 GObjectClass parent_class;
70 GstRTSPClient * (*create_client) (GstRTSPServer *server);
73 void (*client_connected) (GstRTSPServer *server, GstRTSPClient *client);
76 GType gst_rtsp_server_get_type (void);
78 GstRTSPServer * gst_rtsp_server_new (void);
80 void gst_rtsp_server_set_address (GstRTSPServer *server, const gchar *address);
81 gchar * gst_rtsp_server_get_address (GstRTSPServer *server);
83 void gst_rtsp_server_set_service (GstRTSPServer *server, const gchar *service);
84 gchar * gst_rtsp_server_get_service (GstRTSPServer *server);
86 void gst_rtsp_server_set_backlog (GstRTSPServer *server, gint backlog);
87 gint gst_rtsp_server_get_backlog (GstRTSPServer *server);
89 int gst_rtsp_server_get_bound_port (GstRTSPServer *server);
91 void gst_rtsp_server_set_session_pool (GstRTSPServer *server, GstRTSPSessionPool *pool);
92 GstRTSPSessionPool * gst_rtsp_server_get_session_pool (GstRTSPServer *server);
94 void gst_rtsp_server_set_mount_points (GstRTSPServer *server, GstRTSPMountPoints *mounts);
95 GstRTSPMountPoints * gst_rtsp_server_get_mount_points (GstRTSPServer *server);
97 void gst_rtsp_server_set_auth (GstRTSPServer *server, GstRTSPAuth *auth);
98 GstRTSPAuth * gst_rtsp_server_get_auth (GstRTSPServer *server);
100 void gst_rtsp_server_set_thread_pool (GstRTSPServer *server, GstRTSPThreadPool *pool);
101 GstRTSPThreadPool * gst_rtsp_server_get_thread_pool (GstRTSPServer *server);
103 gboolean gst_rtsp_server_transfer_connection (GstRTSPServer * server, GSocket *socket,
104 const gchar * ip, gint port,
105 const gchar *initial_buffer);
107 gboolean gst_rtsp_server_io_func (GSocket *socket, GIOCondition condition,
108 GstRTSPServer *server);
110 GSocket * gst_rtsp_server_create_socket (GstRTSPServer *server,
111 GCancellable *cancellable,
113 GSource * gst_rtsp_server_create_source (GstRTSPServer *server,
114 GCancellable * cancellable,
116 guint gst_rtsp_server_attach (GstRTSPServer *server,
117 GMainContext *context);
120 * GstRTSPServerClientFilterFunc:
121 * @server: a #GstRTSPServer object
122 * @client: a #GstRTSPClient in @server
123 * @user_data: user data that has been given to gst_rtsp_server_client_filter()
125 * This function will be called by the gst_rtsp_server_client_filter(). An
126 * implementation should return a value of #GstRTSPFilterResult.
128 * When this function returns #GST_RTSP_FILTER_REMOVE, @client will be removed
131 * A return value of #GST_RTSP_FILTER_KEEP will leave @client untouched in
134 * A value of #GST_RTSP_FILTER_REF will add @client to the result #GList of
135 * gst_rtsp_server_client_filter().
137 * Returns: a #GstRTSPFilterResult.
139 typedef GstRTSPFilterResult (*GstRTSPServerClientFilterFunc) (GstRTSPServer *server,
140 GstRTSPClient *client,
143 GList * gst_rtsp_server_client_filter (GstRTSPServer *server,
144 GstRTSPServerClientFilterFunc func,
149 #endif /* __GST_RTSP_SERVER_H__ */