Skip to content

OcaApplicationNetwork#

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

Abstract base class from which the application network classes inherit.

Overview#

Class Declaration#

namespace aes70::controller
{
  class OcaApplicationNetwork : public OcaRoot
  {
  public:
    OcaApplicationNetwork(std::shared_ptr<connection> connection,
            uin32_t object_number);
    OcaApplicationNetwork(const OcaApplicationNetwork &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 GetServiceID and calls on_result or on_failure
    void GetServiceID(auto on_result, failure_callback on_failure);
    // Calls SetServiceID and calls on_result or on_failure
    void SetServiceID(OcaApplicationNetworkServiceID Name, auto on_result, failure_callback on_failure);
    // Calls SetServiceID and does not wait for the response
    void SetServiceID(OcaApplicationNetworkServiceID Name);
    // 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<OcaNetworkSystemInterfaceDescriptor> Descriptors, auto on_result, failure_callback on_failure);
    // Calls SetSystemInterfaces and does not wait for the response
    void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceDescriptor> Descriptors);
    // Calls GetState and calls on_result or on_failure
    void GetState(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 Control and calls on_result or on_failure
    void Control(OcaApplicationNetworkCommand Command, auto on_result, failure_callback on_failure);
    // Calls Control and does not wait for the response
    void Control(OcaApplicationNetworkCommand Command);
    // Calls GetPath and calls on_result or on_failure
    void GetPath(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeServiceID(auto callback, failure_callback on_failure);
    subscription observeSystemInterfaces(auto callback, failure_callback on_failure);
    subscription observeState(auto callback, failure_callback on_failure);
    subscription observeErrorCode(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnServiceIDChanged(auto callback, failure_callback on_failure);
    subscription OnSystemInterfacesChanged(auto callback, failure_callback on_failure);
    subscription OnStateChanged(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.

GetServiceID#

void GetServiceID(auto on_result, failure_callback on_failure)

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

SetServiceID#

void SetServiceID(OcaApplicationNetworkServiceID Name, auto on_result, failure_callback on_failure)

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

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<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces
  • failure_callback on_failure: A callback which is called on error.

SetSystemInterfaces#

void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceDescriptor> Descriptors, 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<OcaNetworkSystemInterfaceDescriptor> Descriptors
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • failure_callback on_failure: A callback which is called on error.

GetState#

void GetState(auto on_result, failure_callback on_failure)

Calls the method GetState in the remote device.

Parameters:#

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

Control#

void Control(OcaApplicationNetworkCommand Command, auto on_result, failure_callback on_failure)

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

Parameters:#

  • OcaApplicationNetworkCommand Command
  • auto on_result: A callable (e.g. a lambda) with 0 arguments.
  • 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.

observeServiceID#

subscription observeServiceID(auto callback, failure_callback on_failure)

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

Parameters:#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaApplicationNetworkServiceID ServiceID
  • 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<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces
  • failure_callback on_failure: A callback which is called on error.

observeState#

subscription observeState(auto callback, failure_callback on_failure)

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

Parameters:#

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

OnServiceIDChanged#

subscription OnServiceIDChanged(auto callback, failure_callback on_failure)

Parameters#

  • auto callback: A callable (e.g. a lambda) with one argument: OcaApplicationNetworkServiceID ServiceID
  • 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<OcaNetworkSystemInterfaceDescriptor> SystemInterfaces
  • failure_callback on_failure: A callback which is called on error.

OnStateChanged#

subscription OnStateChanged(auto callback, failure_callback on_failure)

Parameters#

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