Hc_ecss_control_channel_options_clean

Команда сброса настроек контрольной коннекции.

Аналог команды в CoCon:

system/mediactrl/clean

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/ecss_control_channel_options_clean

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Clean settings of control channel to MSR.
            Usage: http://server:9999/commands/ecss_control_channel_options_clean.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemCleanInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemCleanOutType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>
CODE

Пример:

Запрос:
http://192.168.1.21:9999/commands/ecss_control_channel_options_clean

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_clean.xsd">
  <request>
    <system_options>
      <system>
        <option name="mediactrl_keepalive_timeout"/>
        <option name="mediactrl_transaction_timeout"/>
        <option name="msr_ban_end_timeout"/>
      </system>
    </system_options>
  </request>
</in>
CODE

Код ответа:

200

Ответ:

<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_clean.xsd">
    <result>
        <system_options>
            <system>
                <success option="msr_ban_end_timeout"/>
                <success option="mediactrl_transaction_timeout"/>
                <success option="mediactrl_keepalive_timeout"/>
            </system>
        </system_options>
    </result>
</out>
CODE

Hc_ecss_control_channel_options_info

Команда просмотра настроек контрольной коннекции.

Аналог команды в CoCon:

system/mediactrl/info

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/ecss_control_channel_options_info

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Show settings of control channel to MSR.
            Usage: http://server:9999/commands/ecss_control_channel_options_info.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>

    <!-- ControlChannelOptionsType -->
    <xs:complexType name="ControlChannelOptionsType">
        <xs:annotation>
            <xs:documentation xml:lang="en">
                mediactrl_keepalive_timeout and mediactrl_transaction_timeout - Timeout in seconds
                msr_ban_end_timeout - Timeout in milliseconds
            </xs:documentation>
        </xs:annotation>
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="mediactrl_keepalive_timeout" type="integerType"/>
                <xs:attribute name="mediactrl_transaction_timeout" type="integerType"/>
                <xs:attribute name="msr_ban_end_timeout" type="integerType"/>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemInfoInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemInfoOutType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>
XML

Пример:

Запрос:
http://192.168.1.21:9999/commands/ecss_control_channel_options_info

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="ecss_control_channel_options_info.xsd">
    <request>
        <system_options/>
    </request>
</in>
CODE

Код ответа:

200

Ответ:

<?xml version="1.0"?>
<out
    xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_info.xsd">
    <result>
        <system_options>
            <system>
                <options xs:type="ControlChannelOptionsType" mediactrl_keepalive_timeout="10" mediactrl_transaction_timeout="20" msr_ban_end_timeout="1000"/>
            </system>
        </system_options>
    </result>
</out>
CODE

Hc_ecss_control_channel_options_set

Команда изменения настроек контрольной коннекции.

Аналог команды в CoCon:

system/mediactrl/set

Метод HTTP-запроса:

POST

Шаблон HTTP-запроса:

http://host:port/commands/ecss_control_channel_options_set

Код HTTP-ответа:

  • 200 – в случае успеха;
  • 404 – в случае ошибки.

XSD-схема XML-запроса/ответа:

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:annotation>
        <xs:documentation xml:lang="en">
            Show settings of control channel to MSR.
            Usage: http://server:9999/commands/ecss_control_channel_options_set.
        </xs:documentation>
    </xs:annotation>
    <xs:include schemaLocation="error.xsd"/>
    <xs:include schemaLocation="ecm_common.xsd"/>

    <!-- ControlChannelOptionsType -->
    <xs:complexType name="ControlChannelOptionsType">
        <xs:annotation>
            <xs:documentation xml:lang="en">
                mediactrl_keepalive_timeout and mediactrl_transaction_timeout - Timeout in seconds
                msr_ban_end_timeout - Timeout in milliseconds
            </xs:documentation>
        </xs:annotation>
        <xs:complexContent>
            <xs:extension base="baseOptionsType">
                <xs:attribute name="mediactrl_keepalive_timeout" type="integerType"/>
                <xs:attribute name="mediactrl_transaction_timeout" type="integerType"/>
                <xs:attribute name="msr_ban_end_timeout" type="integerType"/>
            </xs:extension>
        </xs:complexContent>
    </xs:complexType>

    <!-- in -->
    <xs:element name="in">
        <xs:complexType>
            <xs:all>
                <xs:element name="request">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemSetInType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
            </xs:all>
        </xs:complexType>
    </xs:element>
    <!-- out -->
    <xs:element name="out">
        <xs:complexType>
            <xs:choice>
                <xs:element name="result">
                    <xs:complexType>
                        <xs:all>
                            <xs:element name="system_options" type="systemSetOutType"/>
                        </xs:all>
                    </xs:complexType>
                </xs:element>
                <xs:element name="error" type="errorType"/>
            </xs:choice>
        </xs:complexType>
    </xs:element>
</xs:schema>
CODE

Пример:

Запрос:
http://192.168.1.21:9999/commands/ecss_control_channel_options_set

<?xml version="1.0" encoding="UTF-8"?>
<in xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_set.xsd">
  <request>
    <system_options>
      <system>
        <options mediactrl_keepalive_timeout="10" mediactrl_transaction_timeout="20" msr_ban_end_timeout="1000" xs:type="ControlChannelOptionsType"/>
      </system>
    </system_options>
  </request>
</in>
CODE

Код ответа:

200

Ответ:

<?xml version="1.0"?>
<out xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" xs:noNamespaceSchemaLocation="ecss_control_channel_options_set.xsd">
    <result>
        <system_options>
            <system>
                <success option="msr_ban_end_timeout"/>
                <success option="mediactrl_transaction_timeout"/>
                <success option="mediactrl_keepalive_timeout"/>
            </system>
        </system_options>
    </result>
</out>
CODE