OcaControlNetwork

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

---

Overview

• ClassID: 1.4.1
• Header: aes70/controller/OcaControlNetwork.hpp
• Namespace: aes70::controller
• Inheritance: aes70::controller::OcaApplicationNetwork, aes70::controller::OcaRoot, aes70::controller::object

Class Declaration

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

    // Control Methods
    // Calls GetControlProtocol and calls on_result or on_failure
    void GetControlProtocol(auto on_result, failure_callback on_failure);

    // Observing Properties
    subscription observeProtocol(auto callback, failure_callback on_failure);

    // Property Changed Subscriptions
    subscription OnProtocolChanged(auto callback, failure_callback on_failure);
  };
}

Methods

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.

observeProtocol

subscription observeProtocol(auto callback, failure_callback on_failure)

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

Parameters:

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

OnProtocolChanged

subscription OnProtocolChanged(auto callback, failure_callback on_failure)

Parameters

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