gst/rtsp-server/rtsp-session.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 #include <gst/rtsp/gstrtsptransport.h>
  23
  24 #ifndef __GST_RTSP_SESSION_H__
  25 #define __GST_RTSP_SESSION_H__
  26
  27 G_BEGIN_DECLS
  28
  29 #define GST_TYPE_RTSP_SESSION              (gst_rtsp_session_get_type ())
  30 #define GST_IS_RTSP_SESSION(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_SESSION))
  31 #define GST_IS_RTSP_SESSION_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_SESSION))
  32 #define GST_RTSP_SESSION_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_SESSION, GstRTSPSessionClass))
  33 #define GST_RTSP_SESSION(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_SESSION, GstRTSPSession))
  34 #define GST_RTSP_SESSION_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_SESSION, GstRTSPSessionClass))
  35 #define GST_RTSP_SESSION_CAST(obj)         ((GstRTSPSession*)(obj))
  36 #define GST_RTSP_SESSION_CLASS_CAST(klass) ((GstRTSPSessionClass*)(klass))
  37
  38 typedef struct _GstRTSPSession GstRTSPSession;
  39 typedef struct _GstRTSPSessionClass GstRTSPSessionClass;
  40 typedef struct _GstRTSPSessionPrivate GstRTSPSessionPrivate;
  41
  42 /**
  43  * GstRTSPFilterResult:
  44  * @GST_RTSP_FILTER_REMOVE: Remove session
  45  * @GST_RTSP_FILTER_KEEP: Keep session in the pool
  46  * @GST_RTSP_FILTER_REF: Ref session in the result list
  47  *
  48  * Possible return values for gst_rtsp_session_pool_filter().
  49  */
  50 typedef enum
  51 {
  52   GST_RTSP_FILTER_REMOVE,
  53   GST_RTSP_FILTER_KEEP,
  54   GST_RTSP_FILTER_REF,
  55 } GstRTSPFilterResult;
  56
  57 #include "rtsp-media.h"
  58 #include "rtsp-session-media.h"
  59
  60 /**
  61  * GstRTSPSession:
  62  *
  63  * Session information kept by the server for a specific client.
  64  * One client session, identified with a session id, can handle multiple medias
  65  * identified with the url of a media.
  66  */
  67 struct _GstRTSPSession {
  68   GObject       parent;
  69
  70   /*< private >*/
  71   GstRTSPSessionPrivate *priv;
  72   gpointer _gst_reserved[GST_PADDING];
  73 };
  74
  75 struct _GstRTSPSessionClass {
  76   GObjectClass  parent_class;
  77
  78   /*< private >*/
  79   gpointer _gst_reserved[GST_PADDING];
  80 };
  81
  82 GType                  gst_rtsp_session_get_type             (void);
  83
  84 /* create a new session */
  85 GstRTSPSession *       gst_rtsp_session_new                  (const gchar *sessionid);
  86
  87 const gchar *          gst_rtsp_session_get_sessionid        (GstRTSPSession *session);
  88
  89 gchar *                gst_rtsp_session_get_header           (GstRTSPSession *session);
  90
  91 void                   gst_rtsp_session_set_timeout          (GstRTSPSession *session, guint timeout);
  92 guint                  gst_rtsp_session_get_timeout          (GstRTSPSession *session);
  93
  94 /* session timeout stuff */
  95 void                   gst_rtsp_session_touch                (GstRTSPSession *session);
  96 void                   gst_rtsp_session_prevent_expire       (GstRTSPSession *session);
  97 void                   gst_rtsp_session_allow_expire         (GstRTSPSession *session);
  98 gint                   gst_rtsp_session_next_timeout         (GstRTSPSession *session, GTimeVal *now);
  99 gboolean               gst_rtsp_session_is_expired           (GstRTSPSession *session, GTimeVal *now);
 100
 101 /* handle media in a session */
 102 GstRTSPSessionMedia *  gst_rtsp_session_manage_media         (GstRTSPSession *sess,
 103                                                               const gchar *path,
 104                                                               GstRTSPMedia *media);
 105 gboolean               gst_rtsp_session_release_media        (GstRTSPSession *sess,
 106                                                               GstRTSPSessionMedia *media);
 107 /* get media in a session */
 108 GstRTSPSessionMedia *  gst_rtsp_session_get_media            (GstRTSPSession *sess,
 109                                                               const gchar *path,
 110                                                               gint * matched);
 111
 112 /**
 113  * GstRTSPSessionFilterFunc:
 114  * @sess: a #GstRTSPSession object
 115  * @media: a #GstRTSPSessionMedia in @sess
 116  * @user_data: user data that has been given to gst_rtsp_session_filter()
 117  *
 118  * This function will be called by the gst_rtsp_session_filter(). An
 119  * implementation should return a value of #GstRTSPFilterResult.
 120  *
 121  * When this function returns #GST_RTSP_FILTER_REMOVE, @media will be removed
 122  * from @sess.
 123  *
 124  * A return value of #GST_RTSP_FILTER_KEEP will leave @media untouched in
 125  * @sess.
 126  *
 127  * A value of GST_RTSP_FILTER_REF will add @media to the result #GList of
 128  * gst_rtsp_session_filter().
 129  *
 130  * Returns: a #GstRTSPFilterResult.
 131  */
 132 typedef GstRTSPFilterResult (*GstRTSPSessionFilterFunc)  (GstRTSPSession *sess,
 133                                                           GstRTSPSessionMedia *media,
 134                                                           gpointer user_data);
 135
 136 GList *                gst_rtsp_session_filter           (GstRTSPSession *sess,
 137                                                           GstRTSPSessionFilterFunc func,
 138                                                           gpointer user_data);
 139
 140
 141 G_END_DECLS
 142
 143 #endif /* __GST_RTSP_SESSION_H__ */