docs: improve docs
authorWim Taymans <wim.taymans@collabora.co.uk>
Thu, 11 Jul 2013 14:57:14 +0000 (16:57 +0200)
committerWim Taymans <wim.taymans@collabora.co.uk>
Thu, 11 Jul 2013 14:57:14 +0000 (16:57 +0200)
24 files changed:
docs/README
docs/libs/gst-rtsp-server-docs.sgml
docs/libs/gst-rtsp-server-sections.txt
gst/rtsp-server/rtsp-address-pool.c
gst/rtsp-server/rtsp-auth.c
gst/rtsp-server/rtsp-client.c
gst/rtsp-server/rtsp-client.h
gst/rtsp-server/rtsp-media-factory-uri.c
gst/rtsp-server/rtsp-media-factory.c
gst/rtsp-server/rtsp-media-factory.h
gst/rtsp-server/rtsp-media.c
gst/rtsp-server/rtsp-mount-points.c
gst/rtsp-server/rtsp-params.c
gst/rtsp-server/rtsp-permissions.c
gst/rtsp-server/rtsp-sdp.c
gst/rtsp-server/rtsp-server.c
gst/rtsp-server/rtsp-server.h
gst/rtsp-server/rtsp-session-media.c
gst/rtsp-server/rtsp-session-pool.c
gst/rtsp-server/rtsp-session.c
gst/rtsp-server/rtsp-stream-transport.c
gst/rtsp-server/rtsp-stream.c
gst/rtsp-server/rtsp-thread-pool.c
gst/rtsp-server/rtsp-token.c

index 943382e29f5b6b4b2ba3cd14ae687ca45f31e145..f2e878bd394380223fcc11c57aa0086748947639 100644 (file)
@@ -93,8 +93,8 @@ can build simple server applications with it.
      g_main_loop_run (loop);
    }
 
- The server manages two other objects: GstRTSPSessionPool and
- GstRTSPMountPoints
+ The server manages four other objects: GstRTSPSessionPool,
+ GstRTSPMountPoints, GstRTSPAuth and GstRTSPThreadPool.
 
  The GstRTSPSessionPool is an object that keeps track of all the active sessions
  in the server. A session will usually be kept for each client that performed a
@@ -109,6 +109,12 @@ can build simple server applications with it.
  request URL to a specific stream and its configuration. We explain in the next
  topic how to configure this object.
 
+ GstRTSPAuth is an object that authenticates users and authorizes actions
+ performed by users.
+
+ GstRTSPThreadPool manages the threads used for client connections and media
+ pipelines.
+
 
 * Making url mount points
 
index 716d8b216f4c781f4c25d3b19898b647eed47e81..4035cc8d69971acffd6fe67d9577422a61a99e79 100644 (file)
     <xi:include href="xml/rtsp-mount-points.xml"/>
     <xi:include href="xml/rtsp-media-factory.xml"/>
     <xi:include href="xml/rtsp-media-factory-uri.xml"/>
+    <xi:include href="xml/rtsp-media.xml"/>
+    <xi:include href="xml/rtsp-stream.xml"/>
     <xi:include href="xml/rtsp-session-pool.xml"/>
     <xi:include href="xml/rtsp-session.xml"/>
-    <xi:include href="xml/rtsp-media.xml"/>
+    <xi:include href="xml/rtsp-session-media.xml"/>
+    <xi:include href="xml/rtsp-stream-transport.xml"/>
     <xi:include href="xml/rtsp-sdp.xml"/>
     <xi:include href="xml/rtsp-address-pool.xml"/>
+    <xi:include href="xml/rtsp-thread-pool.xml"/>
     <xi:include href="xml/rtsp-auth.xml"/>
     <xi:include href="xml/rtsp-token.xml"/>
     <xi:include href="xml/rtsp-permissions.xml"/>
index edfe53ecb7aeef5ea6cfb65eaa33afdac35437b6..3e6d6be7e2608e01320eededf2aa9973b4c5abd8 100644 (file)
@@ -1,6 +1,8 @@
 <SECTION>
 <FILE>rtsp-address-pool</FILE>
 <TITLE>GstRTSPAddressPool</TITLE>
+
+<SUBSECTION Address>
 GST_RTSP_ADDRESS_POOL_ANY_IPV4
 GST_RTSP_ADDRESS_POOL_ANY_IPV6
 GstRTSPAddress
@@ -8,6 +10,7 @@ GstRTSPAddressFlags
 gst_rtsp_address_copy
 gst_rtsp_address_free
 
+<SUBSECTION AddressPool>
 GstRTSPAddressPool
 GstRTSPAddressPoolClass
 gst_rtsp_address_pool_new
@@ -45,10 +48,12 @@ gst_rtsp_auth_remove_basic
 gst_rtsp_auth_setup
 gst_rtsp_auth_check
 
+<SUBSECTION AuthChecks>
 GST_RTSP_AUTH_CHECK_URL
 GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS
 GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT
 
+<SUBSECTION AuthPermissions>
 GST_RTSP_MEDIA_FACTORY_ROLE
 GST_RTSP_MEDIA_FACTORY_PERM_ACCESS
 GST_RTSP_MEDIA_FACTORY_PERM_CONSTRUCT
@@ -68,9 +73,11 @@ gst_rtsp_auth_get_type
 <SECTION>
 <FILE>rtsp-client</FILE>
 <TITLE>GstRTSPClient</TITLE>
+<SUBSECTION ClientState>
 GstRTSPClientState
 gst_rtsp_client_state_get_current
 
+<SUBSECTION Client>
 GstRTSPClient
 GstRTSPClientClass
 
@@ -82,24 +89,25 @@ gst_rtsp_client_set_session_pool
 gst_rtsp_client_get_mount_points
 gst_rtsp_client_set_mount_points
 
-gst_rtsp_client_get_use_client_settings
-gst_rtsp_client_set_use_client_settings
-
 gst_rtsp_client_get_auth
 gst_rtsp_client_set_auth
 
 gst_rtsp_client_get_thread_pool
 gst_rtsp_client_set_thread_pool
 
+gst_rtsp_client_get_use_client_settings
+gst_rtsp_client_set_use_client_settings
+
 gst_rtsp_client_get_connection
 gst_rtsp_client_set_connection
 
+gst_rtsp_client_attach
+
 GstRTSPClientSendFunc
 gst_rtsp_client_set_send_func
 
 gst_rtsp_client_handle_message
 gst_rtsp_client_send_request
-gst_rtsp_client_attach
 
 GstRTSPClientSessionFilterFunc
 gst_rtsp_client_session_filter
@@ -190,29 +198,30 @@ GstRTSPMediaFactoryClass
 
 gst_rtsp_media_factory_new
 
-gst_rtsp_media_factory_construct
-gst_rtsp_media_factory_create_element
-
-gst_rtsp_media_factory_get_address_pool
-gst_rtsp_media_factory_set_address_pool
-
-gst_rtsp_media_factory_get_buffer_size
-gst_rtsp_media_factory_set_buffer_size
-
 gst_rtsp_media_factory_get_launch
 gst_rtsp_media_factory_set_launch
 
 gst_rtsp_media_factory_get_permissions
 gst_rtsp_media_factory_set_permissions
 
-gst_rtsp_media_factory_get_protocols
-gst_rtsp_media_factory_set_protocols
+gst_rtsp_media_factory_set_shared
+gst_rtsp_media_factory_is_shared
 
 gst_rtsp_media_factory_is_eos_shutdown
 gst_rtsp_media_factory_set_eos_shutdown
 
-gst_rtsp_media_factory_set_shared
-gst_rtsp_media_factory_is_shared
+gst_rtsp_media_factory_get_protocols
+gst_rtsp_media_factory_set_protocols
+
+gst_rtsp_media_factory_get_address_pool
+gst_rtsp_media_factory_set_address_pool
+
+gst_rtsp_media_factory_get_buffer_size
+gst_rtsp_media_factory_set_buffer_size
+
+gst_rtsp_media_factory_construct
+gst_rtsp_media_factory_create_element
+
 <SUBSECTION Standard>
 GST_RTSP_MEDIA_FACTORY_CAST
 GST_RTSP_MEDIA_FACTORY_CLASS_CAST
@@ -316,11 +325,14 @@ gst_rtsp_server_set_address
 gst_rtsp_server_get_service
 gst_rtsp_server_set_service
 
-gst_rtsp_server_get_bound_port
-
 gst_rtsp_server_get_backlog
 gst_rtsp_server_set_backlog
 
+gst_rtsp_server_get_tls_certificate
+gst_rtsp_server_set_tls_certificate
+
+gst_rtsp_server_get_bound_port
+
 gst_rtsp_server_get_mount_points
 gst_rtsp_server_set_mount_points
 
@@ -333,9 +345,6 @@ gst_rtsp_server_set_thread_pool
 gst_rtsp_server_get_auth
 gst_rtsp_server_set_auth
 
-gst_rtsp_server_get_tls_certificate
-gst_rtsp_server_set_tls_certificate
-
 gst_rtsp_server_get_use_client_settings
 gst_rtsp_server_set_use_client_settings
 
@@ -562,6 +571,7 @@ gst_rtsp_stream_transport_get_type
 <SECTION>
 <FILE>rtsp-thread-pool</FILE>
 <TITLE>GstRTSPThreadPool</TITLE>
+<SUBSECTION Thread>
 GstRTSPThreadType
 GstRTSPThread
 
@@ -571,6 +581,7 @@ gst_rtsp_thread_unref
 gst_rtsp_thread_reuse
 gst_rtsp_thread_stop
 
+<SUBSECTION ThreadPool>
 GstRTSPThreadPool
 GstRTSPThreadPoolClass
 gst_rtsp_thread_pool_new
index c5c0727e867a50f8ebb314c6a7df1437234f78ed..297f85cba5c0c311379620492f0156831bf60588 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-address-pool
+ * @short_description: A pool of network addresses
+ * @see_also: #GstRTSPStream, #GstRTSPStreamTransport
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 #include <gio/gio.h>
index 06f5aeba7dcaca904579deb083c480daa0304ed8..dc0b2e04a7556d978664e75959ef926ef4864725 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-auth
+ * @short_description: Authentication and authorization
+ * @see_also: #GstRTSPPermission, #GstRTSPtoken
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 
index d5feb6ffe0662fa2063d9baaf63b22d43aa504ea..6df8059e514ebe05da13bac346f8371667f50d1e 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-client
+ * @short_description: A client connection state
+ * @see_also: #GstRTSPServer, #GstRTSPThreadPool
+ *
+ * The client object handles the connection with a client for as long as a TCP
+ * connection is open.
+ *
+ * A #GstRTSPClient is created by #GstRTSPServer when a new connection is
+ * accepted and it inherits the #GstRTSPMountPoints, #GstRTSPSessionPool,
+ * #GstRTSPAuth and #GstRTSPThreadPool from the server.
+ *
+ * The client connection should be configured with the #GstRTSPConnection using
+ * gst_rtsp_client_set_connection() before it can be attached to a #GMainContext
+ * using gst_rtsp_client_attach(). From then on the client will handle requests
+ * on the connection.
+ *
+ * Use gst_rtsp_client_session_filter() to iterate or modify all the
+ * #GstRTSPSession objects managed by the client object.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <stdio.h>
 #include <string.h>
@@ -2391,6 +2413,9 @@ gst_rtsp_client_get_connection (GstRTSPClient * client)
  * Set @func as the callback that will be called when a new message needs to be
  * sent to the client. @user_data is passed to @func and @notify is called when
  * @user_data is no longer in use.
+ *
+ * By default, the client will send the messages on the #GstRTSPConnection that
+ * was configured with gst_rtsp_client_attach() was called.
  */
 void
 gst_rtsp_client_set_send_func (GstRTSPClient * client,
@@ -2453,7 +2478,8 @@ gst_rtsp_client_handle_message (GstRTSPClient * client,
  * @session: a #GstRTSPSession to send the request to or %NULL
  * @request: The request #GstRTSPMessage to send
  *
- * Send a request message to the client.
+ * Send a request message to the remote end. @request must be a
+ * #GST_RTSP_MESSAGE_REQUEST.
  */
 GstRTSPResult
 gst_rtsp_client_send_request (GstRTSPClient * client, GstRTSPSession * session,
@@ -2733,6 +2759,7 @@ gst_rtsp_client_attach (GstRTSPClient * client, GMainContext * context)
 
   g_return_val_if_fail (GST_IS_RTSP_CLIENT (client), 0);
   priv = client->priv;
+  g_return_val_if_fail (priv->connection != NULL, 0);
   g_return_val_if_fail (priv->watch == NULL, 0);
 
   /* create watch for the connection and attach */
index cd5de87ea15a76fb10d7585272b87b5e440020ea..82f5eec91ea0848fefd00d9026c9848a3ba128a5 100644 (file)
@@ -160,32 +160,32 @@ void                  gst_rtsp_client_set_mount_points  (GstRTSPClient *client,
                                                          GstRTSPMountPoints *mounts);
 GstRTSPMountPoints *  gst_rtsp_client_get_mount_points  (GstRTSPClient *client);
 
-void                  gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
-                                                               gboolean use_client_settings);
-gboolean              gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
-
 void                  gst_rtsp_client_set_auth          (GstRTSPClient *client, GstRTSPAuth *auth);
 GstRTSPAuth *         gst_rtsp_client_get_auth          (GstRTSPClient *client);
 
 void                  gst_rtsp_client_set_thread_pool   (GstRTSPClient *client, GstRTSPThreadPool *pool);
 GstRTSPThreadPool *   gst_rtsp_client_get_thread_pool   (GstRTSPClient *client);
 
+void                  gst_rtsp_client_set_use_client_settings (GstRTSPClient * client,
+                                                               gboolean use_client_settings);
+gboolean              gst_rtsp_client_get_use_client_settings (GstRTSPClient * client);
+
 gboolean              gst_rtsp_client_set_connection    (GstRTSPClient *client, GstRTSPConnection *conn);
 GstRTSPConnection *   gst_rtsp_client_get_connection    (GstRTSPClient *client);
 
+guint                 gst_rtsp_client_attach            (GstRTSPClient *client,
+                                                         GMainContext *context);
+
 void                  gst_rtsp_client_set_send_func     (GstRTSPClient *client,
                                                          GstRTSPClientSendFunc func,
                                                          gpointer user_data,
                                                          GDestroyNotify notify);
+
 GstRTSPResult         gst_rtsp_client_handle_message    (GstRTSPClient *client,
                                                          GstRTSPMessage *message);
-
 GstRTSPResult         gst_rtsp_client_send_request      (GstRTSPClient * client,
                                                          GstRTSPSession *session,
                                                          GstRTSPMessage *request);
-guint                 gst_rtsp_client_attach            (GstRTSPClient *client,
-                                                         GMainContext *context);
-
 /**
  * GstRTSPClientSessionFilterFunc:
  * @client: a #GstRTSPClient object
index e2e80d93ef2bb1fd3113ee9bbf0ba21065c57ac0..46300a9f629833cc6c8274cdbd6c26920112c886 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-media-factory-uri
+ * @short_description: A factory for URI sources
+ * @see_also: #GstRTSPMediaFactory, #GstRTSPMedia
+ *
+ * This specialized #GstRTSPMediaFactory constructs media pipelines from a URI,
+ * given with gst_rtsp_media_factory_uri_set_uri().
+ *
+ * It will automatically demux and payload the different streams found in the
+ * media at URL.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 
index 2864f40ae33cc7107d41e88b0695819d1d585323..391ea83e588f8236297f99af2d8caefbe41ce68f 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-media-factory
+ * @short_description: A factory for media pipelines
+ * @see_also: #GstRTSPMountPoints, #GstRTSPMedia
+ *
+ * The #GstRTSPMediaFactory is responsible for creating or recycling
+ * #GstRTSPMedia objects based on the passed URL.
+ *
+ * The default implementation of the object can create #GstRTSPMedia objects
+ * containing a pipeline created from a launch description set with
+ * gst_rtsp_media_factory_set_launch().
+ *
+ * Media from a factory can be shared by setting the shared flag with
+ * gst_rtsp_media_factory_set_shared(). When a factory is shared,
+ * gst_rtsp_media_factory_construct() will return the same #GstRTSPMedia when
+ * the url matches.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include "rtsp-media-factory.h"
 
index 035cbe2cb0ee52eff73ba65bec42f1a9a53956b4..2815d95f1e3159d9a3b1a96e0c9f0460330552b6 100644 (file)
@@ -69,10 +69,10 @@ struct _GstRTSPMediaFactory {
  *       #GstRTSPMedia for @url. The default implementation of this
  *       function calls create_element to retrieve an element and then looks for
  *       pay%d to create the streams.
- * @configure: configure the media created with @construct. The default
- *       implementation will configure the 'shared' property of the media.
  * @create_pipeline: create a new pipeline or re-use an existing one and
  *       add the #GstRTSPMedia's element created by @construct to the pipeline.
+ * @configure: configure the media created with @construct. The default
+ *       implementation will configure the 'shared' property of the media.
  * @media_constructed: signal emited when a media was constructed
  * @media_configure: signal emited when a media should be configured
  *
@@ -85,8 +85,8 @@ struct _GstRTSPMediaFactoryClass {
 
   GstElement *    (*create_element)     (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
   GstRTSPMedia *  (*construct)          (GstRTSPMediaFactory *factory, const GstRTSPUrl *url);
-  void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
   GstElement *    (*create_pipeline)    (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
+  void            (*configure)          (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
 
   /* signals */
   void            (*media_constructed)  (GstRTSPMediaFactory *factory, GstRTSPMedia *media);
@@ -99,14 +99,14 @@ GType                 gst_rtsp_media_factory_get_type     (void);
 GstRTSPMediaFactory * gst_rtsp_media_factory_new          (void);
 
 /* configuring the factory */
-void                  gst_rtsp_media_factory_set_permissions  (GstRTSPMediaFactory *factory,
-                                                               GstRTSPPermissions *permissions);
-GstRTSPPermissions *  gst_rtsp_media_factory_get_permissions  (GstRTSPMediaFactory *factory);
-
 void                  gst_rtsp_media_factory_set_launch       (GstRTSPMediaFactory *factory,
                                                                const gchar *launch);
 gchar *               gst_rtsp_media_factory_get_launch       (GstRTSPMediaFactory *factory);
 
+void                  gst_rtsp_media_factory_set_permissions  (GstRTSPMediaFactory *factory,
+                                                               GstRTSPPermissions *permissions);
+GstRTSPPermissions *  gst_rtsp_media_factory_get_permissions  (GstRTSPMediaFactory *factory);
+
 void                  gst_rtsp_media_factory_set_shared       (GstRTSPMediaFactory *factory,
                                                                gboolean shared);
 gboolean              gst_rtsp_media_factory_is_shared        (GstRTSPMediaFactory *factory);
index 46706fa6bfa082bf02f787be1788fc2454fe0308..78f5f853c49b38cc256b710aeb39ce5d6bc1d95f 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-media
+ * @short_description: The media pipeline
+ * @see_also: #GstRTSPMediaFactory, #GstRTSPStream
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 #include <stdlib.h>
index 9df3c757dc1b5cab3f0f7aaf84a5a95c60692347..86c7a4369a8e3a36843fd3b70d72d92b6e39c576 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
-
+/**
+ * SECTION:rtsp-mount-points
+ * @short_description: Map a path to media
+ * @see_also: #GstRTSPMediaFactory, #GstRTSPClient
+ *
+ * A #GstRTSPMountPoints object maintains a relation between paths
+ * and #GstRTSPMediaFactory objects. This object is usually given to
+ * #GstRTSPClient and used to find the media attached to a path.
+ *
+ * With gst_rtsp_mount_points_add_factory () and
+ * gst_rtsp_mount_points_remove_factory(), factories can be added and
+ * removed.
+ *
+ * With gst_rtsp_mount_points_match() you can find the #GstRTSPMediaFactory
+ * object that completely matches the given path.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 #include <string.h>
 
 #include "rtsp-mount-points.h"
index be45e0fc6699b8672eae7104f19a1a940ad44f5a..d1f9b698c1689241ef98625ab050804728d4cf4f 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-params
+ * @short_description: Param get and set implementation
+ * @see_also: #GstRTSPClient
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
+
 #include <string.h>
 
 #include "rtsp-params.h"
index f4098676a905cc5ee01721e6eae0a09c198c8a5f..eae9383be93b84b7848468391b776a5e120f8321 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-permissions
+ * @short_description: Roles and associated permissions
+ * @see_also: #GstRTSPToken, #GstRTSPAuth
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
+
 
 #include <string.h>
 
index 5dfec79d9735ec5b42ce5d71132fdc4b19d1f3cf..be94d19b5529ac57597251cc1f9863a60df3a656 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-sdp
+ * @short_description: Make SDP messages
+ * @see_also: #GstRTSPMedia
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
+
 #include <string.h>
 
 #include "rtsp-sdp.h"
index 8f63d3430e7382af26ae3f9c31627a7eb597c2b2..f9766b61b9992789e6cd0a55107693d3f810f57d 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
-
+/**
+ * SECTION:rtsp-server
+ * @short_description: The main server object
+ * @see_also: #GstRTSPClient, #GstRTSPThreadPool
+ *
+ * The server object is the object listening for connections on a port and
+ * creating #GstRTSPClient objects to handle those connections.
+ *
+ * The server will listen on the address set with gst_rtsp_server_set_address()
+ * and the port or service configured with gst_rtsp_server_set_service().
+ * Use gst_rtsp_server_set_backlog() to configure the amount of pending requests
+ * that the server will keep. By default the server listens on the current
+ * network (0.0.0.0) and port 8554.
+ *
+ * The server will require an SSL connection when a TLS certificate has been
+ * set with gst_rtsp_server_set_tls_certificate().
+ *
+ * To start the server, use gst_rtsp_server_attach() to attach it to a
+ * #GMainContext. For more control, gst_rtsp_server_create_source() and
+ * gst_rtsp_server_create_socket() can be used to get a #GSource and #GSocket
+ * respectively.
+ *
+ * gst_rtsp_server_transfer_connection() can be used to transfer an existing
+ * socket to the RTSP server, for example from an HTTP server.
+ *
+ * Once the server socket is attached to a mainloop, it will start accepting
+ * connections. When a new connection is received, a new #GstRTSPClient object
+ * is created to handle the connection. The new client will be configured with
+ * the server #GstRTSPAuth, #GstRTSPMountPoints, #GstRTSPSessionPool and
+ * #GstRTSPThreadPool.
+ *
+ * The server uses the configured #GstRTSPThreadPool object to handle the
+ * remainder of the communication with this client.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 #include <stdlib.h>
 #include <string.h>
 
@@ -99,7 +134,6 @@ GST_DEBUG_CATEGORY_STATIC (rtsp_server_debug);
 #define GST_CAT_DEFAULT rtsp_server_debug
 
 typedef struct _ClientContext ClientContext;
-typedef struct _Loop Loop;
 
 static guint gst_rtsp_server_signals[SIGNAL_LAST] = { 0 };
 
@@ -165,7 +199,7 @@ gst_rtsp_server_class_init (GstRTSPServerClass * klass)
    * pending connections for the server may grow. If a connection request arrives
    * when the queue is full, the client may receive an error with an indication of
    * ECONNREFUSED or, if the underlying protocol supports retransmission, the
-   * request may be ignored so that a later reattempt at  connection succeeds.
+   * request may be ignored so that a later reattempt at connection succeeds.
    */
   g_object_class_install_property (gobject_class, PROP_BACKLOG,
       g_param_spec_int ("backlog", "Backlog",
@@ -376,6 +410,10 @@ out:
  * @service should be a string containing the service name (see services(5)) or
  * a string containing a port number between 1 and 65535.
  *
+ * When @service is set to "0", the server will listen on a random free
+ * port. The actual used port can be retrieved with
+ * gst_rtsp_server_get_bound_port().
+ *
  * This function must be called before the server is bound.
  */
 void
index 311a01d18c96e2aa810f5faa177bfaf3aaa3a708..7140bff2c44c6995552ab0b6b17901930d115da9 100644 (file)
@@ -56,11 +56,12 @@ struct _GstRTSPServer {
 
 /**
  * GstRTSPServerClass:
- *
  * @create_client: Create, configure a new GstRTSPClient
- *          object that handles the new connection on @socket.
+ *          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.
  * @setup_connection: Setup the new client connection. The default
- *          implementation will configure the TLS certificate.
+ *          implementation will configure the TLS certificate when specified.
  * @client_connected: emited when a new client connected.
  *
  * The RTSP server class structure
@@ -68,8 +69,6 @@ struct _GstRTSPServer {
 struct _GstRTSPServerClass {
   GObjectClass  parent_class;
 
-  GThreadPool *pool;
-
   GstRTSPClient * (*create_client)      (GstRTSPServer *server);
   gboolean        (*setup_connection)   (GstRTSPServer *server, GstRTSPClient *client,
                                          GstRTSPConnection *conn);
@@ -87,11 +86,14 @@ 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);
 
+void                  gst_rtsp_server_set_tls_certificate  (GstRTSPServer *server, GTlsCertificate *cert);
+GTlsCertificate *     gst_rtsp_server_get_tls_certificate  (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);
 
@@ -108,9 +110,6 @@ void                  gst_rtsp_server_set_use_client_settings (GstRTSPServer *se
                                                                gboolean use_client_settings);
 gboolean              gst_rtsp_server_get_use_client_settings (GstRTSPServer *server);
 
-void                  gst_rtsp_server_set_tls_certificate  (GstRTSPServer *server, GTlsCertificate *cert);
-GTlsCertificate *     gst_rtsp_server_get_tls_certificate  (GstRTSPServer *server);
-
 gboolean              gst_rtsp_server_transfer_connection  (GstRTSPServer * server, GSocket *socket,
                                                             const gchar * ip, gint port,
                                                             const gchar *initial_buffer);
index 3f3fd15ef7a472bce662913a01d4eb6b71412434..5740a0440d1f3431924a816e5ecad41d929e26ca 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-session-media
+ * @short_description: Media managed in a session
+ * @see_also: #GstRTSPMedia, #GstRTSPSession
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
+
 #include <string.h>
 
 #include "rtsp-session.h"
index 393ce6568a95d2a792df256f62483c81664c5a42..d18c11c14f6461f69ee7ffde60e9cba552f9b02b 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-session-pool
+ * @short_description: An object for managing sessions
+ * @see_also: #GstRTSPSession
+ *
+ * The #GstRTSPSessionPool object manages a list of #GstRTSPSession objects.
+ *
+ * The maximum number of sessions can be configured with
+ * gst_rtsp_session_pool_set_max_sessions(). The current number of sessions can
+ * be retrieved with gst_rtsp_session_pool_get_n_sessions().
+ *
+ * Use gst_rtsp_session_pool_create() to create a new #GstRTSPSession object.
+ * The session object can be found again with its id and
+ * gst_rtsp_session_pool_find().
+ *
+ * All sessions can be iterated with gst_rtsp_session_pool_filter().
+ *
+ * Run gst_rtsp_session_pool_cleanup() periodically to remove timed out sessions
+ * or use gst_rtsp_session_pool_create_watch() to be notified when session
+ * cleanup should be performed.
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include "rtsp-session-pool.h"
 
index fe93a5f260f0b2f153b085ce78a8fa965f2a0b0d..20540ab82b624b04354098045cee9c6bcc566723 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-session
+ * @short_description: An object to manage media
+ * @see_also: #GstRTSPSessionPool, #GstRTSPSessionMedia, #GstRTSPMedia
+ *
+ * The #GstRTSPSession is identified by an id, unique in the
+ * #GstRTSPSessionPool that created the session and manages media and its
+ * configuration.
+ *
+ * A #GstRTSPSession has a timeout that can be retrieved with
+ * gst_rtsp_session_get_timeout(). You can check if the sessions is expired with
+ * gst_rtsp_session_is_expired(). gst_rtsp_session_touch() will reset the
+ * expiration counter of the session.
+ *
+ * When a client configures a media with SETUP, a session will be created to
+ * keep track of the configuration of that media. With
+ * gst_rtsp_session_manage_media(), the media is added to the managed media
+ * in the session. With gst_rtsp_session_release_media() the media can be
+ * released again from the session. Managed media is identified in the sessions
+ * with a url. Use gst_rtsp_session_get_media() to get the media that matches
+ * (part of) the given url.
+ *
+ * The media in a session can be iterated with gst_rtsp_session_filter().
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
+
 #include <string.h>
 
 #include "rtsp-session.h"
index 0a03ad21c36a24d1a64f64c298daefe17090fc6a..40452c27c7acc3fcaffee114cc7f01b34f7dd904 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-stream-transport
+ * @short_description: A media stream transport configuration
+ * @see_also: #GstRTSPStream
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 #include <stdlib.h>
index fd8038e737e9df79d5afe498a4ab0ccd3a3efcc3..63222c4159653c824ca0d4a7b2363306c9717269 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-stream
+ * @short_description: A media stream
+ * @see_also: #GstRTSPMedia
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <stdlib.h>
 #include <stdio.h>
index 88bd79274995e591fdbee8f2def16f10a3200a46..236da0de2415dc96f87548a2baa52ec80fabea32 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-thread-pool
+ * @short_description: A pool of threads
+ * @see_also: #GstRTSPMedia, #GstRTSPClient
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>
 
index 2a4d29bb5123e0158bed2683383952071b7b3165..f82e58db3ca34550a5fd5e9bc0e4bf12cbf4d1ab 100644 (file)
  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
+/**
+ * SECTION:rtsp-token
+ * @short_description: Roles and permissions for a client
+ * @see_also: #GstRTSPClient, #GstRTSPPermission, #GstRTSPAuth
+ *
+ * Last reviewed on 2013-07-11 (1.0.0)
+ */
 
 #include <string.h>