Skip to content

OcaNetwork#

This document describes the device side implementation of OcaNetwork. This class is documented in the AES70 standard as:

DEPRECATED CLASS Replaced by class OcaControlNetwork in version 3 of Connection Management (CM3)

Abstract base class for defining network classes to which this device belongs. This class is to be used for control and monitoring networks only. For media transport networks, and for networks that combine media transport and control, the OcaStreamNetwork class should be used instead.

Overview#

Class Declaration#

The device side implementation has the following signature.

namespace aes70::device
{
  template <class Implementation>
  class OcaNetwork : public OcaAgent<Implementation>
  {

  };
}

The template argument Implementation may implement the following methods.

Note

The signatures given here are just one possibility and that most methods are optional. Implement only those methods which make sense in the context of your device. See the documentation in Implementing AES70 Classes for more details.

class MyOcaNetworkImplementation
{
  // Methods defined by OcaNetwork
  OcaNetworkLinkType GetLinkType();
  OcaApplicationNetworkServiceID GetIDAdvertised();
  void SetIDAdvertised(OcaApplicationNetworkServiceID Name);
  OcaNetworkControlProtocol GetControlProtocol();
  OcaNetworkMediaProtocol GetMediaProtocol();
  OcaNetworkStatus GetStatus();
  OcaNetworkStatistics GetStatistics();
  void ResetStatistics();
  OcaList<OcaNetworkSystemInterfaceID> GetSystemInterfaces();
  void SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> Interfaces);
  OcaList<OcaONo> GetMediaPorts();
  void Startup();
  void Shutdown();

  // Methods defined by OcaAgent
  OcaString GetLabel();
  void SetLabel(OcaString Label);
  OcaONo GetOwner();
  std::tuple<OcaRolePath,OcaONoPath> GetPath();

  // Methods defined by OcaRoot
  OcaBoolean GetLockable();
  void SetLockNoReadWrite();
  void Unlock();
  OcaString GetRole();
  void SetLockNoWrite();
  OcaLockState GetLockState();

};

Events#