Make rtsp-server.h a single-include header, use it for G-I
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-server.h
index 5220ce1..9a6f9d4 100644 (file)
@@ -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.
  */
 
 #ifndef __GST_RTSP_SERVER_H__
@@ -26,12 +26,27 @@ G_BEGIN_DECLS
 
 typedef struct _GstRTSPServer GstRTSPServer;
 typedef struct _GstRTSPServerClass GstRTSPServerClass;
+typedef struct _GstRTSPServerPrivate GstRTSPServerPrivate;
 
 #include "rtsp-session-pool.h"
-#include "rtsp-media-mapping.h"
-#include "rtsp-media-factory-uri.h"
+#include "rtsp-session.h"
+#include "rtsp-media.h"
+#include "rtsp-stream.h"
+#include "rtsp-stream-transport.h"
+#include "rtsp-address-pool.h"
+#include "rtsp-thread-pool.h"
 #include "rtsp-client.h"
+#include "rtsp-context.h"
+#include "rtsp-server.h"
+#include "rtsp-mount-points.h"
+#include "rtsp-media-factory.h"
+#include "rtsp-permissions.h"
 #include "rtsp-auth.h"
+#include "rtsp-token.h"
+#include "rtsp-session-media.h"
+#include "rtsp-sdp.h"
+#include "rtsp-media-factory-uri.h"
+#include "rtsp-params.h"
 
 #define GST_TYPE_RTSP_SERVER              (gst_rtsp_server_get_type ())
 #define GST_IS_RTSP_SERVER(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SERVER))
@@ -42,10 +57,6 @@ typedef struct _GstRTSPServerClass GstRTSPServerClass;
 #define GST_RTSP_SERVER_CAST(obj)         ((GstRTSPServer*)(obj))
 #define GST_RTSP_SERVER_CLASS_CAST(klass) ((GstRTSPServerClass*)(klass))
 
-#define GST_RTSP_SERVER_GET_LOCK(server)  (&(GST_RTSP_SERVER_CAST(server)->lock))
-#define GST_RTSP_SERVER_LOCK(server)      (g_mutex_lock(GST_RTSP_SERVER_GET_LOCK(server)))
-#define GST_RTSP_SERVER_UNLOCK(server)    (g_mutex_unlock(GST_RTSP_SERVER_GET_LOCK(server)))
-
 /**
  * GstRTSPServer:
  *
@@ -55,34 +66,18 @@ typedef struct _GstRTSPServerClass GstRTSPServerClass;
 struct _GstRTSPServer {
   GObject      parent;
 
-  GMutex       lock;
-
-  /* server information */
-  gchar       *address;
-  gchar       *service;
-  gint         backlog;
-
-  GSocket     *socket;
-
-  /* sessions on this server */
-  GstRTSPSessionPool  *session_pool;
-
-  /* media mapper for this server */
-  GstRTSPMediaMapping *media_mapping;
-
-  /* authentication manager */
-  GstRTSPAuth *auth;
-
-  /* the clients that are connected */
-  GList   *clients;
+  /*< private >*/
+  GstRTSPServerPrivate *priv;
+  gpointer _gst_reserved[GST_PADDING];
 };
 
 /**
  * GstRTSPServerClass:
- *
  * @create_client: Create, configure a new GstRTSPClient
- *          object that handles the new connection on @socket.
- * @accept_client: accept a new GstRTSPClient
+ *          object that handles the new connection on @socket. The default
+ *          implementation will create a GstRTSPClient and will configure the
+ *          mount-points, auth, session-pool and thread-pool on the client.
+ * @client_connected: emited when a new client connected.
  *
  * The RTSP server class structure
  */
@@ -90,10 +85,12 @@ struct _GstRTSPServerClass {
   GObjectClass  parent_class;
 
   GstRTSPClient * (*create_client)      (GstRTSPServer *server);
-  gboolean        (*accept_client)      (GstRTSPServer *server, GstRTSPClient *client,
-                                         GSocket *socket, GError **error);
+
   /* signals */
   void            (*client_connected)   (GstRTSPServer *server, GstRTSPClient *client);
+
+  /*< private >*/
+  gpointer         _gst_reserved[GST_PADDING_LARGE];
 };
 
 GType                 gst_rtsp_server_get_type             (void);
@@ -106,21 +103,26 @@ gchar *               gst_rtsp_server_get_address          (GstRTSPServer *serve
 void                  gst_rtsp_server_set_service          (GstRTSPServer *server, const gchar *service);
 gchar *               gst_rtsp_server_get_service          (GstRTSPServer *server);
 
-int                   gst_rtsp_server_get_bound_port       (GstRTSPServer *server);
-
 void                  gst_rtsp_server_set_backlog          (GstRTSPServer *server, gint backlog);
 gint                  gst_rtsp_server_get_backlog          (GstRTSPServer *server);
 
+int                   gst_rtsp_server_get_bound_port       (GstRTSPServer *server);
+
 void                  gst_rtsp_server_set_session_pool     (GstRTSPServer *server, GstRTSPSessionPool *pool);
 GstRTSPSessionPool *  gst_rtsp_server_get_session_pool     (GstRTSPServer *server);
 
-void                  gst_rtsp_server_set_media_mapping    (GstRTSPServer *server, GstRTSPMediaMapping *mapping);
-GstRTSPMediaMapping * gst_rtsp_server_get_media_mapping    (GstRTSPServer *server);
+void                  gst_rtsp_server_set_mount_points     (GstRTSPServer *server, GstRTSPMountPoints *mounts);
+GstRTSPMountPoints *  gst_rtsp_server_get_mount_points     (GstRTSPServer *server);
 
 void                  gst_rtsp_server_set_auth             (GstRTSPServer *server, GstRTSPAuth *auth);
 GstRTSPAuth *         gst_rtsp_server_get_auth             (GstRTSPServer *server);
 
-gboolean              gst_rtsp_server_transfer_connection  (GstRTSPServer * server, GSocket *socket, const gchar * ip, gint port, const gchar *initial_buffer);
+void                  gst_rtsp_server_set_thread_pool      (GstRTSPServer *server, GstRTSPThreadPool *pool);
+GstRTSPThreadPool *   gst_rtsp_server_get_thread_pool      (GstRTSPServer *server);
+
+gboolean              gst_rtsp_server_transfer_connection  (GstRTSPServer * server, GSocket *socket,
+                                                            const gchar * ip, gint port,
+                                                            const gchar *initial_buffer);
 
 gboolean              gst_rtsp_server_io_func              (GSocket *socket, GIOCondition condition,
                                                             GstRTSPServer *server);
@@ -134,6 +136,34 @@ GSource *             gst_rtsp_server_create_source        (GstRTSPServer *serve
 guint                 gst_rtsp_server_attach               (GstRTSPServer *server,
                                                             GMainContext *context);
 
+/**
+ * GstRTSPServerClientFilterFunc:
+ * @server: a #GstRTSPServer object
+ * @client: a #GstRTSPClient in @server
+ * @user_data: user data that has been given to gst_rtsp_server_client_filter()
+ *
+ * This function will be called by the gst_rtsp_server_client_filter(). An
+ * implementation should return a value of #GstRTSPFilterResult.
+ *
+ * When this function returns #GST_RTSP_FILTER_REMOVE, @client will be removed
+ * from @server.
+ *
+ * A return value of #GST_RTSP_FILTER_KEEP will leave @client untouched in
+ * @server.
+ *
+ * A value of #GST_RTSP_FILTER_REF will add @client to the result #GList of
+ * gst_rtsp_server_client_filter().
+ *
+ * Returns: a #GstRTSPFilterResult.
+ */
+typedef GstRTSPFilterResult (*GstRTSPServerClientFilterFunc)  (GstRTSPServer *server,
+                                                               GstRTSPClient *client,
+                                                               gpointer user_data);
+
+GList *                gst_rtsp_server_client_filter    (GstRTSPServer *server,
+                                                         GstRTSPServerClientFilterFunc func,
+                                                         gpointer user_data);
+
 G_END_DECLS
 
 #endif /* __GST_RTSP_SERVER_H__ */