rtsp-server: Pass ClientState structure arround
[platform/upstream/gstreamer.git] / gst / rtsp-server / rtsp-client.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 #include <gst/rtsp/gstrtspconnection.h>
22
23 #ifndef __GST_RTSP_CLIENT_H__
24 #define __GST_RTSP_CLIENT_H__
25
26 G_BEGIN_DECLS
27
28 typedef struct _GstRTSPClient GstRTSPClient;
29 typedef struct _GstRTSPClientClass GstRTSPClientClass;
30 typedef struct _GstRTSPClientState GstRTSPClientState;
31
32 #include "rtsp-server.h"
33 #include "rtsp-media.h"
34 #include "rtsp-media-mapping.h"
35 #include "rtsp-session-pool.h"
36 #include "rtsp-auth.h"
37
38 #define GST_TYPE_RTSP_CLIENT              (gst_rtsp_client_get_type ())
39 #define GST_IS_RTSP_CLIENT(obj)           (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_RTSP_CLIENT))
40 #define GST_IS_RTSP_CLIENT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_RTSP_CLIENT))
41 #define GST_RTSP_CLIENT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
42 #define GST_RTSP_CLIENT(obj)              (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_RTSP_CLIENT, GstRTSPClient))
43 #define GST_RTSP_CLIENT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_RTSP_CLIENT, GstRTSPClientClass))
44 #define GST_RTSP_CLIENT_CAST(obj)         ((GstRTSPClient*)(obj))
45 #define GST_RTSP_CLIENT_CLASS_CAST(klass) ((GstRTSPClientClass*)(klass))
46
47 /**
48  * GstRTSPClientState:
49  * @request: the complete request
50  * @uri: the complete url parsed from @request
51  * @method: the parsed method of @uri
52  * @session: the session, can be NULL
53  * @sessmedia: the session media for the url can be NULL
54  * @factory: the media factory for the url, can be NULL.
55  * @media: the session media for the url can be NULL
56  * @response: the response
57  *
58  * Information passed around containing the client state of a request.
59  */
60 struct _GstRTSPClientState{
61   GstRTSPMessage      *request;
62   GstRTSPUrl          *uri;
63   GstRTSPMethod        method;
64   GstRTSPSession      *session;
65   GstRTSPSessionMedia *sessmedia;
66   GstRTSPMediaFactory *factory;
67   GstRTSPMedia        *media;
68   GstRTSPMessage      *response;
69 };
70
71 /**
72  * GstRTSPClient:
73  *
74  * @connection: the connection object handling the client request.
75  * @watch: watch for the connection
76  * @watchid: id of the watch
77  * @ip: ip address used by the client to connect to us
78  * @session_pool: handle to the session pool used by the client.
79  * @media_mapping: handle to the media mapping used by the client.
80  * @uri: cached uri
81  * @media: cached media
82  * @streams: a list of streams using @connection.
83  * @sessions: a list of sessions managed by @connection.
84  *
85  * The client structure.
86  */
87 struct _GstRTSPClient {
88   GObject       parent;
89
90   GstRTSPConnection *connection;
91   GstRTSPWatch      *watch;
92   guint              watchid;
93   gchar             *server_ip;
94   gboolean           is_ipv6;
95
96   GstRTSPServer        *server;
97   GstRTSPSessionPool   *session_pool;
98   GstRTSPMediaMapping  *media_mapping;
99   GstRTSPAuth          *auth;
100
101   GstRTSPUrl     *uri;
102   GstRTSPMedia   *media;
103
104   GList *streams;
105   GList *sessions;
106 };
107
108 struct _GstRTSPClientClass {
109   GObjectClass  parent_class;
110 };
111
112 GType                 gst_rtsp_client_get_type          (void);
113
114 GstRTSPClient *       gst_rtsp_client_new               (void);
115
116 void                  gst_rtsp_client_set_server        (GstRTSPClient * client, GstRTSPServer * server);
117 GstRTSPServer *       gst_rtsp_client_get_server        (GstRTSPClient * client);
118
119 void                  gst_rtsp_client_set_session_pool  (GstRTSPClient *client,
120                                                          GstRTSPSessionPool *pool);
121 GstRTSPSessionPool *  gst_rtsp_client_get_session_pool  (GstRTSPClient *client);
122
123 void                  gst_rtsp_client_set_media_mapping (GstRTSPClient *client,
124                                                          GstRTSPMediaMapping *mapping);
125 GstRTSPMediaMapping * gst_rtsp_client_get_media_mapping (GstRTSPClient *client);
126
127 void                  gst_rtsp_client_set_auth          (GstRTSPClient *client, GstRTSPAuth *auth);
128 GstRTSPAuth *         gst_rtsp_client_get_auth          (GstRTSPClient *client);
129
130
131 gboolean              gst_rtsp_client_accept            (GstRTSPClient *client,
132                                                          GIOChannel *channel);
133
134 G_END_DECLS
135
136 #endif /* __GST_RTSP_CLIENT_H__ */