gst/rtsp-server/rtsp-session-pool.h

   1 /* GStreamer
   2  * Copyright (C) 2008 Wim Taymans <wim.taymans at gmail.com>
   3  *
   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.
   8  *
   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.
  13  *
  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.
  18  */
  19
  20 #include <gst/gst.h>
  21
  22 #ifndef __GST_RTSP_SESSION_POOL_H__
  23 #define __GST_RTSP_SESSION_POOL_H__
  24
  25
  26 G_BEGIN_DECLS
  27
  28 typedef struct _GstRTSPSessionPool GstRTSPSessionPool;
  29 typedef struct _GstRTSPSessionPoolClass GstRTSPSessionPoolClass;
  30 typedef struct _GstRTSPSessionPoolPrivate GstRTSPSessionPoolPrivate;
  31
  32 #include "rtsp-session.h"
  33
  34 #define GST_TYPE_RTSP_SESSION_POOL              (gst_rtsp_session_pool_get_type ())
  35 #define GST_IS_RTSP_SESSION_POOL(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SESSION_POOL))
  36 #define GST_IS_RTSP_SESSION_POOL_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SESSION_POOL))
  37 #define GST_RTSP_SESSION_POOL_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SESSION_POOL, GstRTSPSessionPoolClass))
  38 #define GST_RTSP_SESSION_POOL(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SESSION_POOL, GstRTSPSessionPool))
  39 #define GST_RTSP_SESSION_POOL_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SESSION_POOL, GstRTSPSessionPoolClass))
  40 #define GST_RTSP_SESSION_POOL_CAST(obj)         ((GstRTSPSessionPool*)(obj))
  41 #define GST_RTSP_SESSION_POOL_CLASS_CAST(klass) ((GstRTSPSessionPoolClass*)(klass))
  42
  43 /**
  44  * GstRTSPSessionPool:
  45  * @max_sessions: the maximum number of sessions.
  46  * @lock: locking the session hashtable
  47  * @sessions: hashtable of sessions indexed by the session id.
  48  *
  49  * An object that keeps track of the active sessions. This object is usually
  50  * attached to a #GstRTSPServer object to manage the sessions in that server.
  51  */
  52 struct _GstRTSPSessionPool {
  53   GObject       parent;
  54
  55   /*< private >*/
  56   GstRTSPSessionPoolPrivate *priv;
  57 };
  58
  59 /**
  60  * GstRTSPSessionPoolClass:
  61  * @create_session_id: create a new random session id. Subclasses can create
  62  *    custom session ids and should not check if the session exists.
  63  */
  64 struct _GstRTSPSessionPoolClass {
  65   GObjectClass  parent_class;
  66
  67   gchar * (*create_session_id)   (GstRTSPSessionPool *pool);
  68 };
  69
  70 /**
  71  * GstRTSPSessionPoolFunc:
  72  * @pool: a #GstRTSPSessionPool object
  73  * @user_data: user data that has been given when registering the handler
  74  *
  75  * The function that will be called from the GSource watch on the session pool.
  76  *
  77  * The function will be called when the pool must be cleaned up because one or
  78  * more sessions timed out.
  79  *
  80  * Returns: %FALSE if the source should be removed.
  81  */
  82 typedef gboolean (*GstRTSPSessionPoolFunc)  (GstRTSPSessionPool *pool, gpointer user_data);
  83
  84 /**
  85  * GstRTSPSessionPoolFilterFunc:
  86  * @pool: a #GstRTSPSessionPool object
  87  * @session: a #GstRTSPSession in @pool
  88  * @user_data: user data that has been given to gst_rtsp_session_pool_filter()
  89  *
  90  * This function will be called by the gst_rtsp_session_pool_filter(). An
  91  * implementation should return a value of #GstRTSPFilterResult.
  92  *
  93  * When this function returns #GST_RTSP_FILTER_REMOVE, @session will be removed
  94  * from @pool.
  95  *
  96  * A return value of #GST_RTSP_FILTER_KEEP will leave @session untouched in
  97  * @pool.
  98  *
  99  * A value of GST_RTSP_FILTER_REF will add @session to the result #GList of
 100  * gst_rtsp_session_pool_filter().
 101  *
 102  * Returns: a #GstRTSPFilterResult.
 103  */
 104 typedef GstRTSPFilterResult (*GstRTSPSessionPoolFilterFunc)  (GstRTSPSessionPool *pool,
 105                                                               GstRTSPSession *session,
 106                                                               gpointer user_data);
 107
 108
 109 GType                 gst_rtsp_session_pool_get_type          (void);
 110
 111 /* creating a session pool */
 112 GstRTSPSessionPool *  gst_rtsp_session_pool_new               (void);
 113
 114 /* counting sessionss */
 115 void                  gst_rtsp_session_pool_set_max_sessions  (GstRTSPSessionPool *pool, guint max);
 116 guint                 gst_rtsp_session_pool_get_max_sessions  (GstRTSPSessionPool *pool);
 117
 118 guint                 gst_rtsp_session_pool_get_n_sessions    (GstRTSPSessionPool *pool);
 119
 120 /* managing sessions */
 121 GstRTSPSession *      gst_rtsp_session_pool_create            (GstRTSPSessionPool *pool);
 122 GstRTSPSession *      gst_rtsp_session_pool_find              (GstRTSPSessionPool *pool,
 123                                                                const gchar *sessionid);
 124 gboolean              gst_rtsp_session_pool_remove            (GstRTSPSessionPool *pool,
 125                                                                GstRTSPSession *sess);
 126
 127 /* perform session maintenance */
 128 GList *               gst_rtsp_session_pool_filter            (GstRTSPSessionPool *pool,
 129                                                                GstRTSPSessionPoolFilterFunc func,
 130                                                                gpointer user_data);
 131 guint                 gst_rtsp_session_pool_cleanup           (GstRTSPSessionPool *pool);
 132 GSource *             gst_rtsp_session_pool_create_watch      (GstRTSPSessionPool *pool);
 133
 134 G_END_DECLS
 135
 136 #endif /* __GST_RTSP_SESSION_POOL_H__ */