Skip to content

OcaNetworkInterface#

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

Represents the device's connection to a data network.

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaNetworkInterface : public OcaRoot
  {
  public:
    OcaNetworkInterface(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaNetworkInterface(const OcaNetworkInterface &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 GetEnabled and calls on_result or on_failure
    void GetEnabled(auto on_result, failure_callback on_failure);
    // Calls SetEnabled and calls on_result or on_failure
    void SetEnabled(OcaBoolean Enabled, auto on_result, failure_callback on_failure);
    // Calls SetEnabled and does not wait for the response
    void SetEnabled(OcaBoolean Enabled);
    // Calls GetSystemIoInterfaceName and calls on_result or on_failure
    void GetSystemIoInterfaceName(auto on_result, failure_callback on_failure);
    // Calls SetSystemIoInterfaceName and calls on_result or on_failure
    void SetSystemIoInterfaceName(OcaString Identifier, auto on_result, failure_callback on_failure);
    // Calls SetSystemIoInterfaceName and does not wait for the response
    void SetSystemIoInterfaceName(OcaString Identifier);
    // Calls GetGroupID and calls on_result or on_failure
    void GetGroupID(auto on_result, failure_callback on_failure);
    // Calls SetGroupID and calls on_result or on_failure
    void SetGroupID(OcaUint16 Id, auto on_result, failure_callback on_failure);
    // Calls SetGroupID and does not wait for the response
    void SetGroupID(OcaUint16 Id);
    // Calls GetPrecedence and calls on_result or on_failure
    void GetPrecedence(auto on_result, failure_callback on_failure);
    // Calls SetPrecedence and calls on_result or on_failure
    void SetPrecedence(OcaUint8 Precedence, auto on_result, failure_callback on_failure);
    // Calls SetPrecedence and does not wait for the response
    void SetPrecedence(OcaUint8 Precedence);
    // Calls GetAdaptationIdentifier and calls on_result or on_failure
    void GetAdaptationIdentifier(auto on_result, failure_callback on_failure);
    // Calls GetActiveNetworkSettings and calls on_result or on_failure
    void GetActiveNetworkSettings(auto on_result, failure_callback on_failure);
    // Calls GetTargetNetworkSettings and calls on_result or on_failure
    void GetTargetNetworkSettings(auto on_result, failure_callback on_failure);
    // Calls SetTargetNetworkSettings and calls on_result or on_failure
    void SetTargetNetworkSettings(OcaBlob Settings, auto on_result, failure_callback on_failure);
    // Calls SetTargetNetworkSettings and does not wait for the response
    void SetTargetNetworkSettings(OcaBlob Settings);
    // Calls GetNetworkSettingsPending and calls on_result or on_failure
    void GetNetworkSettingsPending(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 GetErrorCode and calls on_result or on_failure
    void GetErrorCode(auto on_result, failure_callback on_failure);
    // 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);
    // Calls ApplyCommand and calls on_result or on_failure
    void ApplyCommand(OcaNetworkInterfaceCommand Command, auto on_result, failure_callback on_failure);
    // Calls ApplyCommand and does not wait for the response
    void ApplyCommand(OcaNetworkInterfaceCommand Command);

    // Observing Properties
    subscription observeLabel(auto callback, failure_callback on_failure);
    subscription observeEnabled(auto callback, failure_callback on_failure);
    subscription observeSystemIoInterfaceName(auto callback, failure_callback on_failure);
    subscription observeGroupID(auto callback, failure_callback on_failure);
    subscription observePrecedence(auto callback, failure_callback on_failure);
    subscription observeAdaptationIdentifier(auto callback, failure_callback on_failure);
    subscription observeActiveNetworkSettings(auto callback, failure_callback on_failure);
    subscription observeTargetNetworkSettings(auto callback, failure_callback on_failure);
    subscription observeNetworkSettingsPending(auto callback, failure_callback on_failure);
    subscription observeStatus(auto callback, failure_callback on_failure);
    subscription observeErrorCode(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnLabelChanged(auto callback, failure_callback on_failure);
    subscription OnEnabledChanged(auto callback, failure_callback on_failure);
    subscription OnSystemIoInterfaceNameChanged(auto callback, failure_callback on_failure);
    subscription OnGroupIDChanged(auto callback, failure_callback on_failure);
    subscription OnPrecedenceChanged(auto callback, failure_callback on_failure);
    subscription OnAdaptationIdentifierChanged(auto callback, failure_callback on_failure);
    subscription OnActiveNetworkSettingsChanged(auto callback, failure_callback on_failure);
    subscription OnTargetNetworkSettingsChanged(auto callback, failure_callback on_failure);
    subscription OnNetworkSettingsPendingChanged(auto callback, failure_callback on_failure);
    subscription OnStatusChanged(auto callback, failure_callback on_failure);
    subscription OnErrorCodeChanged(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.

GetEnabled#

void GetEnabled(auto on_result, failure_callback on_failure)

Calls the method GetEnabled in the remote device.

Parameters:#

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

SetEnabled#

void SetEnabled(OcaBoolean Enabled, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetSystemIoInterfaceName#

void GetSystemIoInterfaceName(auto on_result, failure_callback on_failure)

Calls the method GetSystemIoInterfaceName in the remote device.

Parameters:#

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

SetSystemIoInterfaceName#

void SetSystemIoInterfaceName(OcaString Identifier, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetGroupID#

void GetGroupID(auto on_result, failure_callback on_failure)

Calls the method GetGroupID in the remote device.

Parameters:#

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

SetGroupID#

void SetGroupID(OcaUint16 Id, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetPrecedence#

void GetPrecedence(auto on_result, failure_callback on_failure)

Calls the method GetPrecedence in the remote device.

Parameters:#

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

SetPrecedence#

void SetPrecedence(OcaUint8 Precedence, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaUint8 Precedence
  • 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.

GetActiveNetworkSettings#

void GetActiveNetworkSettings(auto on_result, failure_callback on_failure)

Calls the method GetActiveNetworkSettings in the remote device.

Parameters:#

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

GetTargetNetworkSettings#

void GetTargetNetworkSettings(auto on_result, failure_callback on_failure)

Calls the method GetTargetNetworkSettings in the remote device.

Parameters:#

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

SetTargetNetworkSettings#

void SetTargetNetworkSettings(OcaBlob Settings, auto on_result, failure_callback on_failure)

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

Parameters:#

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

GetNetworkSettingsPending#

void GetNetworkSettingsPending(auto on_result, failure_callback on_failure)

Calls the method GetNetworkSettingsPending in the remote device.

Parameters:#

  • auto on_result: A callable (e.g. a lambda) with the following arguments:
    • OcaBoolean Pending
  • 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:
    • OcaNetworkInterfaceStatus Status
  • failure_callback on_failure: A callback which is called on error.

GetErrorCode#

void GetErrorCode(auto on_result, failure_callback on_failure)

Calls the method GetErrorCode in the remote device.

Parameters:#

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

ApplyCommand#

void ApplyCommand(OcaNetworkInterfaceCommand Command, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaNetworkInterfaceCommand Command
  • 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.

observeEnabled#

subscription observeEnabled(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeSystemIoInterfaceName#

subscription observeSystemIoInterfaceName(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeGroupID#

subscription observeGroupID(auto callback, failure_callback on_failure)

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

Parameters:#

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

observePrecedence#

subscription observePrecedence(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeAdaptationIdentifier#

subscription observeAdaptationIdentifier(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeActiveNetworkSettings#

subscription observeActiveNetworkSettings(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeTargetNetworkSettings#

subscription observeTargetNetworkSettings(auto callback, failure_callback on_failure)

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

Parameters:#

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

observeNetworkSettingsPending#

subscription observeNetworkSettingsPending(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaBoolean NetworkSettingsPending
  • 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: OcaNetworkInterfaceStatus Status
  • failure_callback on_failure: A callback which is called on error.

observeErrorCode#

subscription observeErrorCode(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnEnabledChanged#

subscription OnEnabledChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnSystemIoInterfaceNameChanged#

subscription OnSystemIoInterfaceNameChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnGroupIDChanged#

subscription OnGroupIDChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnPrecedenceChanged#

subscription OnPrecedenceChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnAdaptationIdentifierChanged#

subscription OnAdaptationIdentifierChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnActiveNetworkSettingsChanged#

subscription OnActiveNetworkSettingsChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnTargetNetworkSettingsChanged#

subscription OnTargetNetworkSettingsChanged(auto callback, failure_callback on_failure)

Parameters#

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

OnNetworkSettingsPendingChanged#

subscription OnNetworkSettingsPendingChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaBoolean NetworkSettingsPending
  • 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: OcaNetworkInterfaceStatus Status
  • failure_callback on_failure: A callback which is called on error.

OnErrorCodeChanged#

subscription OnErrorCodeChanged(auto callback, failure_callback on_failure)

Parameters#

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