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., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, 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
  41 #include "rtsp-media.h"
  42 #include "rtsp-session-media.h"
  43
  44 /**
  45  * GstRTSPSession:
  46  * @sessionid: the session id of the session
  47  * @timeout: the timeout of the session
  48  * @create_time: the time when the session was created
  49  * @last_access: the time the session was last accessed
  50  * @expire_count: the expire prevention counter
  51  * @media: a list of #GstRTSPSessionMedia managed in this session
  52  *
  53  * Session information kept by the server for a specific client.
  54  * One client session, identified with a session id, can handle multiple medias
  55  * identified with the url of a media.
  56  */
  57 struct _GstRTSPSession {
  58   GObject       parent;
  59
  60   gchar        *sessionid;
  61
  62   guint         timeout;
  63   GTimeVal      create_time;
  64   GTimeVal      last_access;
  65   gint          expire_count;
  66
  67   GList        *medias;
  68 };
  69
  70 struct _GstRTSPSessionClass {
  71   GObjectClass  parent_class;
  72 };
  73
  74 GType                  gst_rtsp_session_get_type             (void);
  75
  76 /* create a new session */
  77 GstRTSPSession *       gst_rtsp_session_new                  (const gchar *sessionid);
  78
  79 const gchar *          gst_rtsp_session_get_sessionid        (GstRTSPSession *session);
  80
  81 void                   gst_rtsp_session_set_timeout          (GstRTSPSession *session, guint timeout);
  82 guint                  gst_rtsp_session_get_timeout          (GstRTSPSession *session);
  83
  84 /* session timeout stuff */
  85 void                   gst_rtsp_session_touch                (GstRTSPSession *session);
  86 void                   gst_rtsp_session_prevent_expire       (GstRTSPSession *session);
  87 void                   gst_rtsp_session_allow_expire         (GstRTSPSession *session);
  88 gint                   gst_rtsp_session_next_timeout         (GstRTSPSession *session, GTimeVal *now);
  89 gboolean               gst_rtsp_session_is_expired           (GstRTSPSession *session, GTimeVal *now);
  90
  91 /* handle media in a session */
  92 GstRTSPSessionMedia *  gst_rtsp_session_manage_media         (GstRTSPSession *sess,
  93                                                               const GstRTSPUrl *uri,
  94                                                               GstRTSPMedia *media);
  95 gboolean               gst_rtsp_session_release_media        (GstRTSPSession *sess,
  96                                                               GstRTSPSessionMedia *media);
  97 /* get media in a session */
  98 GstRTSPSessionMedia *  gst_rtsp_session_get_media            (GstRTSPSession *sess,
  99                                                               const GstRTSPUrl *url);
 100
 101 G_END_DECLS
 102
 103 #endif /* __GST_RTSP_SESSION_H__ */