OcaNetworkManager

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

Optional manager that collects all network interface and network application objects to which the device belongs. Must be instantiated in every device that has more than one network object., May be instantiated at most once in any device., If instantiated, must have object number 6.

---

Overview

• ClassID: 1.3.6
• Header: aes70/controller/OcaNetworkManager.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaManager, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetNetworks and calls on_result or on_failure
    void GetNetworks(auto on_result, failure_callback on_failure);
    // Calls GetStreamNetworks and calls on_result or on_failure
    void GetStreamNetworks(auto on_result, failure_callback on_failure);
    // Calls GetControlNetworks and calls on_result or on_failure
    void GetControlNetworks(auto on_result, failure_callback on_failure);
    // Calls GetMediaTransportNetworks and calls on_result or on_failure
    void GetMediaTransportNetworks(auto on_result, failure_callback on_failure);
    // Calls GetNetworkInterfaces and calls on_result or on_failure
    void GetNetworkInterfaces(auto on_result, failure_callback on_failure);
    // Calls GetNetworkApplications and calls on_result or on_failure
    void GetNetworkApplications(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeNetworks(auto callback, failure_callback on_failure);
    subscription observeStreamNetworks(auto callback, failure_callback on_failure);
    subscription observeControlNetworks(auto callback, failure_callback on_failure);
    subscription observeMediaTransportNetworks(auto callback, failure_callback on_failure);
    subscription observeNetworkInterfaces(auto callback, failure_callback on_failure);
    subscription observeNetworkApplications(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnNetworksChanged(auto callback, failure_callback on_failure);
    subscription OnStreamNetworksChanged(auto callback, failure_callback on_failure);
    subscription OnControlNetworksChanged(auto callback, failure_callback on_failure);
    subscription OnMediaTransportNetworksChanged(auto callback, failure_callback on_failure);
    subscription OnNetworkInterfacesChanged(auto callback, failure_callback on_failure);
    subscription OnNetworkApplicationsChanged(auto callback, failure_callback on_failure);
  };
}

Methods

GetNetworks

void GetNetworks(auto on_result, failure_callback on_failure)

Calls the method GetNetworks in the remote device.

Parameters:

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

GetStreamNetworks

void GetStreamNetworks(auto on_result, failure_callback on_failure)

Calls the method GetStreamNetworks in the remote device.

Parameters:

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

GetControlNetworks

void GetControlNetworks(auto on_result, failure_callback on_failure)

Calls the method GetControlNetworks in the remote device.

Parameters:

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

GetMediaTransportNetworks

void GetMediaTransportNetworks(auto on_result, failure_callback on_failure)

Calls the method GetMediaTransportNetworks in the remote device.

Parameters:

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

GetNetworkInterfaces

void GetNetworkInterfaces(auto on_result, failure_callback on_failure)

Calls the method GetNetworkInterfaces in the remote device.

Parameters:

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

GetNetworkApplications

void GetNetworkApplications(auto on_result, failure_callback on_failure)

Calls the method GetNetworkApplications in the remote device.

Parameters:

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

observeNetworks

subscription observeNetworks(auto callback, failure_callback on_failure)

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

Parameters:

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

observeStreamNetworks

subscription observeStreamNetworks(auto callback, failure_callback on_failure)

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

Parameters:

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

observeControlNetworks

subscription observeControlNetworks(auto callback, failure_callback on_failure)

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

Parameters:

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

observeMediaTransportNetworks

subscription observeMediaTransportNetworks(auto callback, failure_callback on_failure)

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

Parameters:

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

observeNetworkInterfaces

subscription observeNetworkInterfaces(auto callback, failure_callback on_failure)

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

Parameters:

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

observeNetworkApplications

subscription observeNetworkApplications(auto callback, failure_callback on_failure)

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

Parameters:

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

OnNetworksChanged

subscription OnNetworksChanged(auto callback, failure_callback on_failure)

Parameters

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

OnStreamNetworksChanged

subscription OnStreamNetworksChanged(auto callback, failure_callback on_failure)

Parameters

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

OnControlNetworksChanged

subscription OnControlNetworksChanged(auto callback, failure_callback on_failure)

Parameters

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

OnMediaTransportNetworksChanged

subscription OnMediaTransportNetworksChanged(auto callback, failure_callback on_failure)

Parameters

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

OnNetworkInterfacesChanged

subscription OnNetworkInterfacesChanged(auto callback, failure_callback on_failure)

Parameters

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

OnNetworkApplicationsChanged

subscription OnNetworkApplicationsChanged(auto callback, failure_callback on_failure)

Parameters

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