Skip to content

OcaStreamNetwork#

This document describes the controller implementation of OcaStreamNetwork. This class is documented in the AES70 standard as:

DEPRECATED CLASS Replaced by class OcaMediaTransportNetwork in version 3 of Connection Management (CM3)

Abstract base class for defining network classes to which this device belongs. May be a media transport network, a control and monitoring network, or a network that does both.

There shall be one OcaStreamNetwork instance for each network to which the device belongs.

This class may be subclassed to support networks of various types.

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaStreamNetwork : public OcaAgent
  {
  public:
    OcaStreamNetwork(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaStreamNetwork(const OcaStreamNetwork &o);

    // Control Methods
    // Calls GetLinkType and calls on_result or on_failure
    void GetLinkType(auto on_result, failure_callback on_failure);
    // Calls GetIDAdvertised and calls on_result or on_failure
    void GetIDAdvertised(auto on_result, failure_callback on_failure);
    // Calls SetIDAdvertised and calls on_result or on_failure
    void SetIDAdvertised(OcaNetworkNodeID Name, auto on_result, failure_callback on_failure);
    // Calls SetIDAdvertised and does not wait for the response
    void SetIDAdvertised(OcaNetworkNodeID Name);
    // Calls GetControlProtocol and calls on_result or on_failure
    void GetControlProtocol(auto on_result, failure_callback on_failure);
    // Calls GetMediaProtocol and calls on_result or on_failure
    void GetMediaProtocol(auto on_result, failure_callback on_failure);
    // Calls GetStatus and calls on_result or on_failure
    void GetStatus(auto on_result, failure_callback on_failure);
    // Calls GetStatistics and calls on_result or on_failure
    void GetStatistics(auto on_result, failure_callback on_failure);
    // Calls ResetStatistics and calls on_result or on_failure
    void ResetStatistics(auto on_result, failure_callback on_failure);
    // Calls GetSystemInterfaces and calls on_result or on_failure
    void GetSystemInterfaces(auto on_result, failure_callback on_failure);
    // Calls SetSystemInterfaces and calls on_result or on_failure
    void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> Interfaces, auto on_result, failure_callback on_failure);
    // Calls SetSystemInterfaces and does not wait for the response
    void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> Interfaces);
    // Calls GetStreamConnectorsSource and calls on_result or on_failure
    void GetStreamConnectorsSource(auto on_result, failure_callback on_failure);
    // Calls SetStreamConnectorsSource and calls on_result or on_failure
    void SetStreamConnectorsSource(OcaList<OcaONo> StreamConnectors, auto on_result, failure_callback on_failure);
    // Calls SetStreamConnectorsSource and does not wait for the response
    void SetStreamConnectorsSource(OcaList<OcaONo> StreamConnectors);
    // Calls GetStreamConnectorsSink and calls on_result or on_failure
    void GetStreamConnectorsSink(auto on_result, failure_callback on_failure);
    // Calls SetStreamConnectorsSink and calls on_result or on_failure
    void SetStreamConnectorsSink(OcaList<OcaONo> StreamConnectors, auto on_result, failure_callback on_failure);
    // Calls SetStreamConnectorsSink and does not wait for the response
    void SetStreamConnectorsSink(OcaList<OcaONo> StreamConnectors);
    // Calls GetSignalChannelsSource and calls on_result or on_failure
    void GetSignalChannelsSource(auto on_result, failure_callback on_failure);
    // Calls SetSignalChannelsSource and calls on_result or on_failure
    void SetSignalChannelsSource(OcaList<OcaONo> SignalChannels, auto on_result, failure_callback on_failure);
    // Calls SetSignalChannelsSource and does not wait for the response
    void SetSignalChannelsSource(OcaList<OcaONo> SignalChannels);
    // Calls GetSignalChannelsSink and calls on_result or on_failure
    void GetSignalChannelsSink(auto on_result, failure_callback on_failure);
    // Calls SetSignalChannelsSink and calls on_result or on_failure
    void SetSignalChannelsSink(OcaList<OcaONo> SignalChannels, auto on_result, failure_callback on_failure);
    // Calls SetSignalChannelsSink and does not wait for the response
    void SetSignalChannelsSink(OcaList<OcaONo> SignalChannels);
    // Calls Startup and calls on_result or on_failure
    void Startup(auto on_result, failure_callback on_failure);
    // Calls Shutdown and calls on_result or on_failure
    void Shutdown(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeIDAdvertised(auto callback, failure_callback on_failure);
    subscription observeControlProtocol(auto callback, failure_callback on_failure);
    subscription observeMediaProtocol(auto callback, failure_callback on_failure);
    subscription observeStatus(auto callback, failure_callback on_failure);
    subscription observeSystemInterfaces(auto callback, failure_callback on_failure);
    subscription observeStreamConnectorsSource(auto callback, failure_callback on_failure);
    subscription observeStreamConnectorsSink(auto callback, failure_callback on_failure);
    subscription observeSignalChannelsSource(auto callback, failure_callback on_failure);
    subscription observeSignalChannelsSink(auto callback, failure_callback on_failure);
    subscription observeStatistics(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnIDAdvertisedChanged(auto callback, failure_callback on_failure);
    subscription OnControlProtocolChanged(auto callback, failure_callback on_failure);
    subscription OnMediaProtocolChanged(auto callback, failure_callback on_failure);
    subscription OnStatusChanged(auto callback, failure_callback on_failure);
    subscription OnSystemInterfacesChanged(auto callback, failure_callback on_failure);
    subscription OnStreamConnectorsSourceChanged(auto callback, failure_callback on_failure);
    subscription OnStreamConnectorsSinkChanged(auto callback, failure_callback on_failure);
    subscription OnSignalChannelsSourceChanged(auto callback, failure_callback on_failure);
    subscription OnSignalChannelsSinkChanged(auto callback, failure_callback on_failure);
    subscription OnStatisticsChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetLinkType#

void GetLinkType(auto on_result, failure_callback on_failure)

Calls the method GetLinkType in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkLinkType Type
  • failure_callback on_failure: A callback which is called on error.

GetIDAdvertised#

void GetIDAdvertised(auto on_result, failure_callback on_failure)

Calls the method GetIDAdvertised in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkNodeID Name
  • failure_callback on_failure: A callback which is called on error.

SetIDAdvertised#

void SetIDAdvertised(OcaNetworkNodeID Name, auto on_result, failure_callback on_failure)

Calls the method SetIDAdvertised in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaNetworkNodeID Name
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetControlProtocol#

void GetControlProtocol(auto on_result, failure_callback on_failure)

Calls the method GetControlProtocol in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkControlProtocol Protocol
  • failure_callback on_failure: A callback which is called on error.

GetMediaProtocol#

void GetMediaProtocol(auto on_result, failure_callback on_failure)

Calls the method GetMediaProtocol in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkMediaProtocol Protocol
  • failure_callback on_failure: A callback which is called on error.

GetStatus#

void GetStatus(auto on_result, failure_callback on_failure)

Calls the method GetStatus in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkStatus Status
  • failure_callback on_failure: A callback which is called on error.

GetStatistics#

void GetStatistics(auto on_result, failure_callback on_failure)

Calls the method GetStatistics in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaNetworkStatistics Status
  • failure_callback on_failure: A callback which is called on error.

ResetStatistics#

void ResetStatistics(auto on_result, failure_callback on_failure)

Calls the method ResetStatistics in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetSystemInterfaces#

void GetSystemInterfaces(auto on_result, failure_callback on_failure)

Calls the method GetSystemInterfaces in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaNetworkSystemInterfaceID> Interfaces
  • failure_callback on_failure: A callback which is called on error.

SetSystemInterfaces#

void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> Interfaces, auto on_result, failure_callback on_failure)

Calls the method SetSystemInterfaces in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaList<OcaNetworkSystemInterfaceID> Interfaces
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetStreamConnectorsSource#

void GetStreamConnectorsSource(auto on_result, failure_callback on_failure)

Calls the method GetStreamConnectorsSource in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaONo> StreamConnectors
  • failure_callback on_failure: A callback which is called on error.

SetStreamConnectorsSource#

void SetStreamConnectorsSource(OcaList<OcaONo> StreamConnectors, auto on_result, failure_callback on_failure)

Calls the method SetStreamConnectorsSource in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaList<OcaONo> StreamConnectors
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetStreamConnectorsSink#

void GetStreamConnectorsSink(auto on_result, failure_callback on_failure)

Calls the method GetStreamConnectorsSink in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaONo> StreamConnectors
  • failure_callback on_failure: A callback which is called on error.

SetStreamConnectorsSink#

void SetStreamConnectorsSink(OcaList<OcaONo> StreamConnectors, auto on_result, failure_callback on_failure)

Calls the method SetStreamConnectorsSink in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaList<OcaONo> StreamConnectors
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetSignalChannelsSource#

void GetSignalChannelsSource(auto on_result, failure_callback on_failure)

Calls the method GetSignalChannelsSource in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaONo> SignalChannels
  • failure_callback on_failure: A callback which is called on error.

SetSignalChannelsSource#

void SetSignalChannelsSource(OcaList<OcaONo> SignalChannels, auto on_result, failure_callback on_failure)

Calls the method SetSignalChannelsSource in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaList<OcaONo> SignalChannels
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetSignalChannelsSink#

void GetSignalChannelsSink(auto on_result, failure_callback on_failure)

Calls the method GetSignalChannelsSink in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaONo> SignalChannels
  • failure_callback on_failure: A callback which is called on error.

SetSignalChannelsSink#

void SetSignalChannelsSink(OcaList<OcaONo> SignalChannels, auto on_result, failure_callback on_failure)

Calls the method SetSignalChannelsSink in the remote device. If no result and error callback is specified, the method will be called without requesting a response.

Parameters:#

  • OcaList<OcaONo> SignalChannels
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

Startup#

void Startup(auto on_result, failure_callback on_failure)

Calls the method Startup in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

Shutdown#

void Shutdown(auto on_result, failure_callback on_failure)

Calls the method Shutdown in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

observeIDAdvertised#

subscription observeIDAdvertised(auto callback, failure_callback on_failure)

Fetches the remote property IDAdvertised and subscribes for modifications. The callback is called with the initial values of IDAdvertised and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkNodeID IDAdvertised
  • failure_callback on_failure: A callback which is called on error.

observeControlProtocol#

subscription observeControlProtocol(auto callback, failure_callback on_failure)

Fetches the remote property ControlProtocol and subscribes for modifications. The callback is called with the initial values of ControlProtocol and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkControlProtocol ControlProtocol
  • failure_callback on_failure: A callback which is called on error.

observeMediaProtocol#

subscription observeMediaProtocol(auto callback, failure_callback on_failure)

Fetches the remote property MediaProtocol and subscribes for modifications. The callback is called with the initial values of MediaProtocol and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkMediaProtocol MediaProtocol
  • failure_callback on_failure: A callback which is called on error.

observeStatus#

subscription observeStatus(auto callback, failure_callback on_failure)

Fetches the remote property Status and subscribes for modifications. The callback is called with the initial values of Status and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkStatus Status
  • failure_callback on_failure: A callback which is called on error.

observeSystemInterfaces#

subscription observeSystemInterfaces(auto callback, failure_callback on_failure)

Fetches the remote property SystemInterfaces and subscribes for modifications. The callback is called with the initial values of SystemInterfaces and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaNetworkSystemInterfaceID> SystemInterfaces
  • failure_callback on_failure: A callback which is called on error.

observeStreamConnectorsSource#

subscription observeStreamConnectorsSource(auto callback, failure_callback on_failure)

Fetches the remote property StreamConnectorsSource and subscribes for modifications. The callback is called with the initial values of StreamConnectorsSource and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> StreamConnectorsSource
  • failure_callback on_failure: A callback which is called on error.

observeStreamConnectorsSink#

subscription observeStreamConnectorsSink(auto callback, failure_callback on_failure)

Fetches the remote property StreamConnectorsSink and subscribes for modifications. The callback is called with the initial values of StreamConnectorsSink and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> StreamConnectorsSink
  • failure_callback on_failure: A callback which is called on error.

observeSignalChannelsSource#

subscription observeSignalChannelsSource(auto callback, failure_callback on_failure)

Fetches the remote property SignalChannelsSource and subscribes for modifications. The callback is called with the initial values of SignalChannelsSource and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> SignalChannelsSource
  • failure_callback on_failure: A callback which is called on error.

observeSignalChannelsSink#

subscription observeSignalChannelsSink(auto callback, failure_callback on_failure)

Fetches the remote property SignalChannelsSink and subscribes for modifications. The callback is called with the initial values of SignalChannelsSink and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> SignalChannelsSink
  • failure_callback on_failure: A callback which is called on error.

observeStatistics#

subscription observeStatistics(auto callback, failure_callback on_failure)

Fetches the remote property Statistics and subscribes for modifications. The callback is called with the initial values of Statistics and whenever it changes.

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkStatistics Statistics
  • failure_callback on_failure: A callback which is called on error.

OnIDAdvertisedChanged#

subscription OnIDAdvertisedChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkNodeID IDAdvertised
  • failure_callback on_failure: A callback which is called on error.

OnControlProtocolChanged#

subscription OnControlProtocolChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkControlProtocol ControlProtocol
  • failure_callback on_failure: A callback which is called on error.

OnMediaProtocolChanged#

subscription OnMediaProtocolChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkMediaProtocol MediaProtocol
  • failure_callback on_failure: A callback which is called on error.

OnStatusChanged#

subscription OnStatusChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkStatus Status
  • failure_callback on_failure: A callback which is called on error.

OnSystemInterfacesChanged#

subscription OnSystemInterfacesChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaNetworkSystemInterfaceID> SystemInterfaces
  • failure_callback on_failure: A callback which is called on error.

OnStreamConnectorsSourceChanged#

subscription OnStreamConnectorsSourceChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> StreamConnectorsSource
  • failure_callback on_failure: A callback which is called on error.

OnStreamConnectorsSinkChanged#

subscription OnStreamConnectorsSinkChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> StreamConnectorsSink
  • failure_callback on_failure: A callback which is called on error.

OnSignalChannelsSourceChanged#

subscription OnSignalChannelsSourceChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> SignalChannelsSource
  • failure_callback on_failure: A callback which is called on error.

OnSignalChannelsSinkChanged#

subscription OnSignalChannelsSinkChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> SignalChannelsSink
  • failure_callback on_failure: A callback which is called on error.

OnStatisticsChanged#

subscription OnStatisticsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaNetworkStatistics Statistics
  • failure_callback on_failure: A callback which is called on error.