mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-26 19:51:11 +00:00
Code Issues 1 Projects Releases Wiki Activity

docs: improve docs

Browse source
This commit is contained in:
Wim Taymans 2013-07-15 17:31:35 +02:00
parent fbe0cefae1
commit 0a8f5c8892
5 changed files with 33 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/libs/gst-rtsp-server-sections.txt
View file

@ -47,7 +47,6 @@ gst_rtsp_auth_set_tls_certificate
gst_rtsp_auth_make_basic
gst_rtsp_auth_add_basic
gst_rtsp_auth_remove_basic
gst_rtsp_auth_setup
gst_rtsp_auth_check
<SUBSECTION AuthChecks>
@ -55,11 +54,15 @@ GST_RTSP_AUTH_CHECK_CONNECT
GST_RTSP_AUTH_CHECK_URL
GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_ACCESS
GST_RTSP_AUTH_CHECK_MEDIA_FACTORY_CONSTRUCT
GST_RTSP_AUTH_CHECK_TRANSPORT_CLIENT_SETTINGS
<SUBSECTION AuthRoles>
GST_RTSP_MEDIA_FACTORY_ROLE
<SUBSECTION AuthPermissions>
GST_RTSP_MEDIA_FACTORY_ROLE
GST_RTSP_MEDIA_FACTORY_PERM_ACCESS
GST_RTSP_MEDIA_FACTORY_PERM_CONSTRUCT
GST_RTSP_TRANSPORT_PERM_CLIENT_SETTINGS
<SUBSECTION Standard>
GST_RTSP_AUTH_CAST
GST_RTSP_AUTH_CLASS_CAST
@ -79,6 +82,8 @@ gst_rtsp_auth_get_type
<SUBSECTION ClientState>
GstRTSPClientState
gst_rtsp_client_state_get_current
gst_rtsp_client_state_pop_current
gst_rtsp_client_state_push_current
<SUBSECTION Client>
GstRTSPClient
@ -98,9 +103,6 @@ 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
@ -110,7 +112,7 @@ GstRTSPClientSendFunc
gst_rtsp_client_set_send_func
gst_rtsp_client_handle_message
gst_rtsp_client_send_request
gst_rtsp_client_send_message
GstRTSPClientSessionFilterFunc
gst_rtsp_client_session_filter
@ -206,6 +208,7 @@ gst_rtsp_media_factory_set_launch
gst_rtsp_media_factory_get_permissions
gst_rtsp_media_factory_set_permissions
gst_rtsp_media_factory_add_role
gst_rtsp_media_factory_set_shared
gst_rtsp_media_factory_is_shared
@ -296,6 +299,7 @@ gst_rtsp_permissions_new
gst_rtsp_permissions_ref
gst_rtsp_permissions_unref
gst_rtsp_permissions_add_role
gst_rtsp_permissions_add_role_valist
gst_rtsp_permissions_remove_role
gst_rtsp_permissions_get_role
gst_rtsp_permissions_is_allowed
@ -345,9 +349,6 @@ gst_rtsp_server_set_thread_pool
gst_rtsp_server_get_auth
gst_rtsp_server_set_auth
gst_rtsp_server_get_use_client_settings
gst_rtsp_server_set_use_client_settings
gst_rtsp_server_transfer_connection
gst_rtsp_server_io_func
gst_rtsp_server_create_socket
@ -612,12 +613,15 @@ gst_rtsp_thread_pool_get_type
<FILE>rtsp-token</FILE>
<TITLE>GstRTSPToken</TITLE>
GstRTSPToken
gst_rtsp_token_new_empty
gst_rtsp_token_new
gst_rtsp_token_new_valist
gst_rtsp_token_ref
gst_rtsp_token_unref
gst_rtsp_token_get_structure
gst_rtsp_token_writable_structure
gst_rtsp_token_get_string
gst_rtsp_token_is_allowed
<SUBSECTION Standard>
GST_RTSP_TOKEN_CAST
GST_IS_RTSP_TOKEN

2
gst/rtsp-server/rtsp-auth.h
View file

@ -150,7 +150,7 @@ gchar * gst_rtsp_auth_make_basic (const gchar * user, const g
*/
#define GST_RTSP_MEDIA_FACTORY_PERM_CONSTRUCT "media.factory.construct"
/**
* GST_RTSP_MEDIA_FACTORY_PERM_CLIENT_SETTINGS:
* GST_RTSP_TRANSPORT_PERM_CLIENT_SETTINGS:
*
* G_TYPE_BOOLEAN, %TRUE if the client can specify TTL, destination and
* port pair in multicast.

4
gst/rtsp-server/rtsp-permissions.c
View file

@ -123,7 +123,7 @@ gst_rtsp_permissions_new (void)
* gst_rtsp_permissions_add_role:
* @permissions: a #GstRTSPPermissions
* @role: a role
* @fielname: the first field name
* @fieldname: the first field name
* @...: additional arguments
*
* Add a new @role to @permissions with the given variables. The fields
@ -144,7 +144,7 @@ gst_rtsp_permissions_add_role (GstRTSPPermissions * permissions,
* gst_rtsp_permissions_add_role_valist:
* @permissions: a #GstRTSPPermissions
* @role: a role
* @fielname: the first field name
* @fieldname: the first field name
* @var_args: additional fields to add
*
* Add a new @role to @permissions with the given variables. Structure fields

4
gst/rtsp-server/rtsp-permissions.h
View file

@ -83,10 +83,10 @@ GstRTSPPermissions * gst_rtsp_permissions_new (void);
void gst_rtsp_permissions_add_role (GstRTSPPermissions *permissions,
const gchar *role,
const gchar *field_name, ...);
const gchar *fieldname, ...);
void gst_rtsp_permissions_add_role_valist (GstRTSPPermissions *permissions,
const gchar *role,
const gchar *field_name,
const gchar *fieldname,
va_list var_args);
void gst_rtsp_permissions_remove_role (GstRTSPPermissions *permissions,
const gchar *role);

18
gst/rtsp-server/rtsp-token.c
View file

@ -21,7 +21,19 @@
* @short_description: Roles and permissions for a client
* @see_also: #GstRTSPClient, #GstRTSPPermission, #GstRTSPAuth
*
* Last reviewed on 2013-07-11 (1.0.0)
* A #GstRTSPToken contains the permissions and roles of the user
* performing the current request. A token is usually created when a user is
* authenticated by the #GstRTSPAuth object and is then placed as the current
* token for the current request.
*
* #GstRTSPAuth can use the token and its contents to check authorization for
* various operations by comparing the token to the #GstRTSPPermissions of the
* object.
*
* The accepted values of the token are entirely defined by the #GstRTSPAuth
* object that implements the security policy.
*
* Last reviewed on 2013-07-15 (1.0.0)
*/
#include <string.h>
@ -120,9 +132,9 @@ gst_rtsp_token_new (const gchar * firstfield, ...)
}
/**
* gst_rtsp_token_new:
* gst_rtsp_token_new_valist:
* @firstfield: the first fieldname
* @var_args additional arguments
* @var_args: additional arguments
*
* Create a new Authorization token with the given fieldnames and values.
* Arguments are given similar to gst_structure_new_valist().