Skip to content

OcaNetwork#

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

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

Abstract base class for defining network classes to which this device belongs. This class is to be used for control and monitoring networks only. For media transport networks, and for networks that combine media transport and control, the OcaStreamNetwork class should be used instead.

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaNetwork : public OcaAgent
  {
  public:
    OcaNetwork(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaNetwork(const OcaNetwork &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(OcaApplicationNetworkServiceID Name, auto on_result, failure_callback on_failure);
    // Calls SetIDAdvertised and does not wait for the response
    void SetIDAdvertised(OcaApplicationNetworkServiceID 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 GetMediaPorts and calls on_result or on_failure
    void GetMediaPorts(auto on_result, failure_callback on_failure);
    // 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 observeMediaPorts(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 OnMediaPortsChanged(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:
    • OcaApplicationNetworkServiceID Name
  • failure_callback on_failure: A callback which is called on error.

SetIDAdvertised#

void SetIDAdvertised(OcaApplicationNetworkServiceID 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:#

  • OcaApplicationNetworkServiceID 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.

GetMediaPorts#

void GetMediaPorts(auto on_result, failure_callback on_failure)

Calls the method GetMediaPorts in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaList<OcaONo> Ports
  • 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: OcaApplicationNetworkServiceID 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.

observeMediaPorts#

subscription observeMediaPorts(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> MediaPorts
  • 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: OcaApplicationNetworkServiceID 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.

OnMediaPortsChanged#

subscription OnMediaPortsChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaList<OcaONo> MediaPorts
  • 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.