Skip to content

OcaNetworkApplication#

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

Base class for network applications

Overview#

Class Declaration#

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

    // Control Methods
    // Calls GetLabel and calls on_result or on_failure
    void GetLabel(auto on_result, failure_callback on_failure);
    // Calls SetLabel and calls on_result or on_failure
    void SetLabel(OcaString Label, auto on_result, failure_callback on_failure);
    // Calls SetLabel and does not wait for the response
    void SetLabel(OcaString Label);
    // Calls GetOwner and calls on_result or on_failure
    void GetOwner(auto on_result, failure_callback on_failure);
    // Calls GetPath and calls on_result or on_failure
    void GetPath(auto on_result, failure_callback on_failure);
    // Calls GetNetworkInterfaceAssignments and calls on_result or on_failure
    void GetNetworkInterfaceAssignments(auto on_result, failure_callback on_failure);
    // Calls SetNetworkInterfaceAssignments and calls on_result or on_failure
    void SetNetworkInterfaceAssignments(OcaList<OcaNetworkInterfaceAssignment> Assignments, auto on_result, failure_callback on_failure);
    // Calls SetNetworkInterfaceAssignments and does not wait for the response
    void SetNetworkInterfaceAssignments(OcaList<OcaNetworkInterfaceAssignment> Assignments);
    // Calls GetAdaptationIdentifier and calls on_result or on_failure
    void GetAdaptationIdentifier(auto on_result, failure_callback on_failure);
    // Calls GetAdaptationData and calls on_result or on_failure
    void GetAdaptationData(auto on_result, failure_callback on_failure);
    // Calls SetAdaptationData and calls on_result or on_failure
    void SetAdaptationData(OcaAdaptationData Data, auto on_result, failure_callback on_failure);
    // Calls SetAdaptationData and does not wait for the response
    void SetAdaptationData(OcaAdaptationData Data);
    // Calls GetCounterSet and calls on_result or on_failure
    void GetCounterSet(auto on_result, failure_callback on_failure);
    // Calls GetCounter and calls on_result or on_failure
    void GetCounter(OcaID16 CounterID, auto on_result, failure_callback on_failure);
    // Calls GetCounter and does not wait for the response
    void GetCounter(OcaID16 CounterID);
    // Calls AttachCounterNotifier and calls on_result or on_failure
    void AttachCounterNotifier(OcaID16 CounterID, OcaONo ONo, auto on_result, failure_callback on_failure);
    // Calls AttachCounterNotifier and does not wait for the response
    void AttachCounterNotifier(OcaID16 CounterID, OcaONo ONo);
    // Calls DetachCounterNotifier and calls on_result or on_failure
    void DetachCounterNotifier(OcaID16 CounterID, OcaONo ONo, auto on_result, failure_callback on_failure);
    // Calls DetachCounterNotifier and does not wait for the response
    void DetachCounterNotifier(OcaID16 CounterID, OcaONo ONo);
    // Calls ResetCounters and calls on_result or on_failure
    void ResetCounters(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeLabel(auto callback, failure_callback on_failure);
    subscription observeNetworkInterfaceAssignments(auto callback, failure_callback on_failure);
    subscription observeAdaptationData(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnLabelChanged(auto callback, failure_callback on_failure);
    subscription OnNetworkInterfaceAssignmentsChanged(auto callback, failure_callback on_failure);
    subscription OnAdaptationDataChanged(auto callback, failure_callback on_failure);
  };
}

Methods#

GetLabel#

void GetLabel(auto on_result, failure_callback on_failure)

Calls the method GetLabel in the remote device.

Parameters:#

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

SetLabel#

void SetLabel(OcaString Label, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetOwner#

void GetOwner(auto on_result, failure_callback on_failure)

Calls the method GetOwner in the remote device.

Parameters:#

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

GetPath#

void GetPath(auto on_result, failure_callback on_failure)

Calls the method GetPath in the remote device.

Parameters:#

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

GetNetworkInterfaceAssignments#

void GetNetworkInterfaceAssignments(auto on_result, failure_callback on_failure)

Calls the method GetNetworkInterfaceAssignments in the remote device.

Parameters:#

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

SetNetworkInterfaceAssignments#

void SetNetworkInterfaceAssignments(OcaList<OcaNetworkInterfaceAssignment> Assignments, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetAdaptationIdentifier#

void GetAdaptationIdentifier(auto on_result, failure_callback on_failure)

Calls the method GetAdaptationIdentifier in the remote device.

Parameters:#

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

GetAdaptationData#

void GetAdaptationData(auto on_result, failure_callback on_failure)

Calls the method GetAdaptationData in the remote device.

Parameters:#

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

SetAdaptationData#

void SetAdaptationData(OcaAdaptationData Data, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetCounterSet#

void GetCounterSet(auto on_result, failure_callback on_failure)

Calls the method GetCounterSet in the remote device.

Parameters:#

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

GetCounter#

void GetCounter(OcaID16 CounterID, auto on_result, failure_callback on_failure)

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

Parameters:#

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

AttachCounterNotifier#

void AttachCounterNotifier(OcaID16 CounterID, OcaONo ONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

DetachCounterNotifier#

void DetachCounterNotifier(OcaID16 CounterID, OcaONo ONo, auto on_result, failure_callback on_failure)

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

Parameters:#

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

ResetCounters#

void ResetCounters(auto on_result, failure_callback on_failure)

Calls the method ResetCounters 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.

observeLabel#

subscription observeLabel(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeNetworkInterfaceAssignments#

subscription observeNetworkInterfaceAssignments(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeAdaptationData#

subscription observeAdaptationData(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnLabelChanged#

subscription OnLabelChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnNetworkInterfaceAssignmentsChanged#

subscription OnNetworkInterfaceAssignmentsChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnAdaptationDataChanged#

subscription OnAdaptationDataChanged(auto callback, failure_callback on_failure)

Parameters#

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