:orphan: .. index:: pair: group; Test API to operate the DLNA UPnP Service information .. _doxid-group__tapi__upnp__service__info: Test API to operate the DLNA UPnP Service information ===================================================== .. toctree:: :hidden: struct_tapi_upnp_action.rst struct_tapi_upnp_argument.rst struct_tapi_upnp_service_info.rst struct_tapi_upnp_state_variable.rst struct_tapi_upnp_sv_allowed_values.rst Overview ~~~~~~~~ Definition of Test API for DLNA UPnP Service features. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_upnp_sv_allowed_values` :ref:`tapi_upnp_sv_allowed_values`; typedef struct :ref:`tapi_upnp_state_variable` :ref:`tapi_upnp_state_variable`; typedef struct tapi_upnp_state_variables :target:`tapi_upnp_state_variables`; typedef struct :ref:`tapi_upnp_argument` :ref:`tapi_upnp_argument`; typedef struct tapi_upnp_action_arguments :target:`tapi_upnp_action_arguments`; typedef struct :ref:`tapi_upnp_action` :ref:`tapi_upnp_action`; typedef struct tapi_upnp_actions :target:`tapi_upnp_actions`; typedef struct :ref:`tapi_upnp_service_info` :ref:`tapi_upnp_service_info`; typedef struct tapi_upnp_services :target:`tapi_upnp_services`; // structs struct :ref:`tapi_upnp_action`; struct :ref:`tapi_upnp_argument`; struct :ref:`tapi_upnp_service_info`; struct :ref:`tapi_upnp_state_variable`; struct :ref:`tapi_upnp_sv_allowed_values`; // global functions :ref:`SLIST_HEAD`(tapi_upnp_state_variables, :ref:`tapi_upnp_state_variable`); :ref:`SLIST_HEAD`(tapi_upnp_action_arguments, :ref:`tapi_upnp_argument`); :ref:`SLIST_HEAD`(tapi_upnp_actions, :ref:`tapi_upnp_action`); :ref:`SLIST_HEAD`(tapi_upnp_services, :ref:`tapi_upnp_service_info`); const char* :ref:`tapi_upnp_get_state_variable_property_string`(const :ref:`tapi_upnp_state_variable`* variable, :ref:`te_upnp_state_variable_property_idx` property_idx); :ref:`te_errno` :ref:`tapi_upnp_get_state_variable_property_boolean`(const :ref:`tapi_upnp_state_variable`* variable, :ref:`te_upnp_state_variable_property_idx` property_idx, bool* value); static const char* :ref:`tapi_upnp_get_state_variable_name`(const :ref:`tapi_upnp_state_variable`* variable); static const char* :ref:`tapi_upnp_get_state_variable_type`(const :ref:`tapi_upnp_state_variable`* variable); static :ref:`te_errno` :ref:`tapi_upnp_get_state_variable_send_events`(const :ref:`tapi_upnp_state_variable`* variable, bool* value); static const char* :ref:`tapi_upnp_get_state_variable_default_value`(const :ref:`tapi_upnp_state_variable`* variable); static const char* :ref:`tapi_upnp_get_state_variable_minimum`(const :ref:`tapi_upnp_state_variable`* variable); static const char* :ref:`tapi_upnp_get_state_variable_maximum`(const :ref:`tapi_upnp_state_variable`* variable); static const char* :ref:`tapi_upnp_get_state_variable_step`(const :ref:`tapi_upnp_state_variable`* variable); const :ref:`tapi_upnp_sv_allowed_values`* :ref:`tapi_upnp_get_state_variable_allowed`(const :ref:`tapi_upnp_state_variable`* variable); const char* :ref:`tapi_upnp_get_service_property_string`(const :ref:`tapi_upnp_service_info`* service, :ref:`te_upnp_service_property_idx` property_idx); static const char* :ref:`tapi_upnp_get_service_id`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_udn`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_type`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_location`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_scpd_url`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_control_url`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_service_event_subscription_url`(const :ref:`tapi_upnp_service_info`* service); static const char* :ref:`tapi_upnp_get_argument_name`(const :ref:`tapi_upnp_argument`* argument); static :ref:`te_upnp_arg_direction` :ref:`tapi_upnp_get_argument_direction`(const :ref:`tapi_upnp_argument`* argument); static const :ref:`tapi_upnp_state_variable`* :ref:`tapi_upnp_get_argument_variable`(const :ref:`tapi_upnp_argument`* argument); static const char* :ref:`tapi_upnp_get_argument_value`(const :ref:`tapi_upnp_argument`* argument); :ref:`te_errno` :ref:`tapi_upnp_set_argument_value`(:ref:`tapi_upnp_argument`* argument, const char* value); :ref:`te_errno` :ref:`tapi_upnp_get_service_info`(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_upnp_device_info`* device, const char* service_id, tapi_upnp_services* services); void :ref:`tapi_upnp_free_service_info`(tapi_upnp_services* services); :ref:`te_errno` :ref:`tapi_upnp_invoke_action`(:ref:`rcf_rpc_server`* rpcs, const :ref:`tapi_upnp_service_info`* service, :ref:`tapi_upnp_action`* action); void :ref:`tapi_upnp_print_service_info`(const tapi_upnp_services* services); .. _details-group__tapi__upnp__service__info: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of Test API for DLNA UPnP Service features. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_upnp_sv_allowed_values .. _doxid-group__tapi__upnp__service__info_1ga517a19f0a7b1655c6bd7dc4fa08bdb06: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_sv_allowed_values` tapi_upnp_sv_allowed_values UPnP state variable allowed values. .. index:: pair: typedef; tapi_upnp_state_variable .. _doxid-group__tapi__upnp__service__info_1gadd484d755cd2768cd1f03383db13465b: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_state_variable` tapi_upnp_state_variable UPnP state variable parameters. .. index:: pair: typedef; tapi_upnp_argument .. _doxid-group__tapi__upnp__service__info_1gaad94bb21c301a59e1fc79477fde404c8: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_argument` tapi_upnp_argument UPnP action argument parameters. Note! The only changable field is **value**. It can be set by user to specify a value or read to get the value after an action execution, other data is filled when service context is retrieved. .. index:: pair: typedef; tapi_upnp_action .. _doxid-group__tapi__upnp__service__info_1gaaca3892d6ddd8f02da0f588dc3b4dd51: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_action` tapi_upnp_action UPnP action. .. index:: pair: typedef; tapi_upnp_service_info .. _doxid-group__tapi__upnp__service__info_1ga624ef6bfefcc6fa0e38ab335661ac787: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_upnp_service_info` tapi_upnp_service_info UPnP service information. Global Functions ---------------- .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__upnp__service__info_1ga6624c6ff7e51b2ae4aeba7f7009bb7e9: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_upnp_state_variables, :ref:`tapi_upnp_state_variable`) Head of the UPnP state variables list for particular service. .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__upnp__service__info_1ga4cc75262f8b6acbb6be6790d7db037c6: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_upnp_action_arguments, :ref:`tapi_upnp_argument`) Head of the UPnP arguments list for particular service action. .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__upnp__service__info_1ga076ed1658c2f10e015c82e548f156b5c: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_upnp_actions, :ref:`tapi_upnp_action`) Head of the UPnP actions list for particular service. .. index:: pair: function; SLIST_HEAD .. _doxid-group__tapi__upnp__service__info_1ga5c8058a3deef55f21c611b608f47fb6d: .. ref-code-block:: cpp :class: doxyrest-title-code-block SLIST_HEAD(tapi_upnp_services, :ref:`tapi_upnp_service_info`) Head of the UPnP services list. .. index:: pair: function; tapi_upnp_get_state_variable_property_string .. _doxid-group__tapi__upnp__service__info_1gaf465d5da54ba5a41485777e84baea657: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_upnp_get_state_variable_property_string(const :ref:`tapi_upnp_state_variable`* variable, :ref:`te_upnp_state_variable_property_idx` property_idx) Get a state variable property string value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. * - property_idx - Index of certain property in properties array. .. rubric:: Returns: The string property value or ``NULL`` if the property is not found. .. index:: pair: function; tapi_upnp_get_state_variable_property_boolean .. _doxid-group__tapi__upnp__service__info_1ga452a440e0bcab5e74432f81dfcaa7535: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_upnp_get_state_variable_property_boolean(const :ref:`tapi_upnp_state_variable`* variable, :ref:`te_upnp_state_variable_property_idx` property_idx, bool* value) Get a state variable property boolean value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. * - property_idx - Index of certain property in properties array. * - value - Requested value. .. rubric:: Returns: Status code. On success, ``0``. .. index:: pair: function; tapi_upnp_get_state_variable_name .. _doxid-group__tapi__upnp__service__info_1ga422466f28cde1679f8c4c52236d44822: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_name(const :ref:`tapi_upnp_state_variable`* variable) Get a Name of the certain state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Name of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_type .. _doxid-group__tapi__upnp__service__info_1gae149031b7887fa753d1b19cdf5037b25: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_type(const :ref:`tapi_upnp_state_variable`* variable) Get a Type of the certain state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Type of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_send_events .. _doxid-group__tapi__upnp__service__info_1ga88d7eec85d7083a276b6246cd0570642: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_upnp_get_state_variable_send_events(const :ref:`tapi_upnp_state_variable`* variable, bool* value) Get a Send Events flag of the certain state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. * - value - Value to return. .. rubric:: Returns: Status code. On success, ``0``. .. index:: pair: function; tapi_upnp_get_state_variable_default_value .. _doxid-group__tapi__upnp__service__info_1ga409f66776254515a24185b09b863e39e: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_default_value(const :ref:`tapi_upnp_state_variable`* variable) Get a Default Value of the certain state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Default Value of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_minimum .. _doxid-group__tapi__upnp__service__info_1ga3917d8b1df7ecb031adf817e6c13afe5: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_minimum(const :ref:`tapi_upnp_state_variable`* variable) Get a Minimum value of the certain state variable. c@ NULL is valid value for non-numerical state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Minimum value of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_maximum .. _doxid-group__tapi__upnp__service__info_1ga3780053fe72c2c6a3172b903ba0a539c: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_maximum(const :ref:`tapi_upnp_state_variable`* variable) Get a Maximum value of the certain state variable. c@ NULL is valid value for non-numerical state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Maximum value of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_step .. _doxid-group__tapi__upnp__service__info_1gac42eca560ba88ead805bb1d96f654b1f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_state_variable_step(const :ref:`tapi_upnp_state_variable`* variable) Get a Step value of the certain state variable. c@ NULL is valid value for non-numerical state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Step value of state variable. .. index:: pair: function; tapi_upnp_get_state_variable_allowed .. _doxid-group__tapi__upnp__service__info_1ga8eb39719c9d76a7491f44e7f77b3d6f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_upnp_sv_allowed_values`* tapi_upnp_get_state_variable_allowed(const :ref:`tapi_upnp_state_variable`* variable) Get a Allowed Values array of the certain state variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - variable - State variable. .. rubric:: Returns: The Allowed Values array of state variable. .. index:: pair: function; tapi_upnp_get_service_property_string .. _doxid-group__tapi__upnp__service__info_1gae3e7d8e1ad519ddeb6316bea9fb62397: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_upnp_get_service_property_string(const :ref:`tapi_upnp_service_info`* service, :ref:`te_upnp_service_property_idx` property_idx) Get a service property string value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. * - property_idx - Index of certain property in properties array. .. rubric:: Returns: The string property value or ``NULL`` if the property is not found. .. index:: pair: function; tapi_upnp_get_service_id .. _doxid-group__tapi__upnp__service__info_1ga0c5c27b93b21a2818fae56cfa1cf91a6: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_id(const :ref:`tapi_upnp_service_info`* service) Get a Service ID. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service ID. .. index:: pair: function; tapi_upnp_get_service_udn .. _doxid-group__tapi__upnp__service__info_1gac371e51e04e4168e8ebc48378c82a410: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_udn(const :ref:`tapi_upnp_service_info`* service) Get a Service Unique Device Name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Unique Device Name. .. index:: pair: function; tapi_upnp_get_service_type .. _doxid-group__tapi__upnp__service__info_1gaf0c8f72a8a21df3ce23fb48c6c3532be: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_type(const :ref:`tapi_upnp_service_info`* service) Get a Service Type. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Type. .. index:: pair: function; tapi_upnp_get_service_location .. _doxid-group__tapi__upnp__service__info_1ga5dac485fc5c6a6842084f637348e98cc: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_location(const :ref:`tapi_upnp_service_info`* service) Get a Service Location. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Location. .. index:: pair: function; tapi_upnp_get_service_scpd_url .. _doxid-group__tapi__upnp__service__info_1gad5a9172e44c85dc6cf273bced03ab82b: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_scpd_url(const :ref:`tapi_upnp_service_info`* service) Get a Service Control Protocol Document URL. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Control Protocol Document URL. .. index:: pair: function; tapi_upnp_get_service_control_url .. _doxid-group__tapi__upnp__service__info_1gafc8e89d2430f5cdb1d00144a6dcd32cc: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_control_url(const :ref:`tapi_upnp_service_info`* service) Get a Service Control URL. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Control URL. .. index:: pair: function; tapi_upnp_get_service_event_subscription_url .. _doxid-group__tapi__upnp__service__info_1gaf3fd9425fefa902dfefebabf9585f30f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_service_event_subscription_url(const :ref:`tapi_upnp_service_info`* service) Get a Service Event Subscription URL. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - service - Service context. .. rubric:: Returns: The Service Event Subscription URL. .. index:: pair: function; tapi_upnp_get_argument_name .. _doxid-group__tapi__upnp__service__info_1gaa31a06b3521edbbdec5c2d0f6478a84b: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_argument_name(const :ref:`tapi_upnp_argument`* argument) Get an Argument name. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - UPnP action argument. .. rubric:: Returns: The Argument name. .. index:: pair: function; tapi_upnp_get_argument_direction .. _doxid-group__tapi__upnp__service__info_1ga8bd30949dc0b6f90f9544d830bf56c67: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_upnp_arg_direction` tapi_upnp_get_argument_direction(const :ref:`tapi_upnp_argument`* argument) Get an Argument direction. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - UPnP action argument. .. rubric:: Returns: The Argument direction. .. index:: pair: function; tapi_upnp_get_argument_variable .. _doxid-group__tapi__upnp__service__info_1ga31589b2ca28a48f7393763e4cc65d2a8: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const :ref:`tapi_upnp_state_variable`* tapi_upnp_get_argument_variable(const :ref:`tapi_upnp_argument`* argument) Get an Argument variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - UPnP action argument. .. rubric:: Returns: The Argument variable. .. index:: pair: function; tapi_upnp_get_argument_value .. _doxid-group__tapi__upnp__service__info_1gaa4e1280c72979fdc063db20467be6e0f: .. ref-code-block:: cpp :class: doxyrest-title-code-block static const char* tapi_upnp_get_argument_value(const :ref:`tapi_upnp_argument`* argument) Get an Argument value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - UPnP action argument. .. rubric:: Returns: The Argument value. .. index:: pair: function; tapi_upnp_set_argument_value .. _doxid-group__tapi__upnp__service__info_1ga4cb8d9405943f882f3b9306dc542d287: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_upnp_set_argument_value(:ref:`tapi_upnp_argument`* argument, const char* value) Set an Argument value. Note, previous set value will be freed, i.e. it is no need to free argument before to set it. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - argument - UPnP action argument. * - value - Null-terminated string value to set, or ``NULL`` to free argument and set it to ``NULL``. .. rubric:: Returns: Status code. On success, ``0``. .. index:: pair: function; tapi_upnp_get_service_info .. _doxid-group__tapi__upnp__service__info_1ga1f60a13185bc543d82f8b5e497bd023a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_upnp_get_service_info(:ref:`rcf_rpc_server`* rpcs, :ref:`tapi_upnp_device_info`* device, const char* service_id, tapi_upnp_services* services) Retrieve an information about available UPnP services. Note, ``services`` should be freed with **tapi_upnp_free_service_info** when it is no longer needed. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle. * - device - The device which provides the service, can be unspecified (``NULL``). * - service_id - Service ID string or ``NULL``. * - services - Service context list. .. rubric:: Returns: Status code. On success, ``0``. .. rubric:: See also: :ref:`tapi_upnp_free_service_info ` .. index:: pair: function; tapi_upnp_free_service_info .. _doxid-group__tapi__upnp__service__info_1ga4609448230d239d8cf76abf8513e7d43: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_upnp_free_service_info(tapi_upnp_services* services) Empty the list of UPnP services (free allocated memory) which was obtained with **tapi_upnp_get_service_info**. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - services - List of services. .. rubric:: See also: :ref:`tapi_upnp_get_service_info ` .. index:: pair: function; tapi_upnp_invoke_action .. _doxid-group__tapi__upnp__service__info_1gae8cfeba576a3e1129083e3284d12601b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_upnp_invoke_action(:ref:`rcf_rpc_server`* rpcs, const :ref:`tapi_upnp_service_info`* service, :ref:`tapi_upnp_action`* action) Execute a UPnP action. Note! **IN** arguments **value** of the ``action`` should be initialized by user or set to ``NULL``, **OUT** arguments **value** must be initialized with ``NULL``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - rpcs - RPC server handle. * - service - Service context. * - action - Requested action to invoke. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_upnp_print_service_info .. _doxid-group__tapi__upnp__service__info_1ga23ef8596bbfb2ab9f30ceb1004cfb97b: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_upnp_print_service_info(const tapi_upnp_services* services) Print UPnP services context using RING function. This function should be used for debugging purpose. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - services - Services context list.