OcaApplicationNetwork

A online version of the AES70 specification of this class can be found at http://docs.deuso.de.

The class is a subclass of OcaRoot().

This class defines the properties

Name

JavaScript Type

AES70 Type

Label

string

OcaString

Owner

number

OcaONo

ServiceID

Uint8Array

OcaApplicationNetworkServiceID

SystemInterfaces

OcaNetworkSystemInterfaceDescriptor[]

OcaList<OcaNetworkSystemInterfaceDescriptor>

State

OcaApplicationNetworkState

OcaApplicationNetworkState

ErrorCode

number

OcaUint16

Furthermore, it inherits the properties ClassID, ClassVersion, ObjectNumber, Lockable, Role, Label, Owner, ServiceID, SystemInterfaces, State and ErrorCode.

class OcaApplicationNetwork(objectNumber, device)

Abstract base class from which the application network classes inherit.

OcaApplicationNetwork.OnErrorCodeChanged

type: PropertyEvent.<number>

This event is emitted when the property ErrorCode changes in the remote object. The property ErrorCode is described in the AES70 standard as follows. Most recent error code. 0=no error.

OcaApplicationNetwork.OnServiceIDChanged

type: PropertyEvent.<Uint8Array>

This event is emitted when the property ServiceID changes in the remote object. The property ServiceID is described in the AES70 standard as follows. Name or GUID that this device publishes in the network’s directory/discovery system to designate the services offered via this application network object. This may or may not be the same as the device’s host name, if any. For data network types that have host names (e.g. IP networks), the authoritative copy of the host name is in the system interface ID.

OcaApplicationNetwork.OnStateChanged

type: PropertyEvent.<OcaApplicationNetworkState>

This event is emitted when the property State changes in the remote object. The property State is described in the AES70 standard as follows. Operational state of the network.

OcaApplicationNetwork.OnSystemInterfacesChanged

type: PropertyEvent.<Array.<OcaNetworkSystemInterfaceDescriptor>>

This event is emitted when the property SystemInterfaces changes in the remote object. The property SystemInterfaces is described in the AES70 standard as follows. Collection of identifiers of system interface descriptor(s) used by the network. A “system interface” is the system service through which network traffic passes into and out of the device – e.g. a socket. The descriptor format is system and network dependent; for OCA purposes, it is maintained as a variable-length blob which the protocol does not inspect.

OcaApplicationNetwork.Control(Command)

Control the application network. Return value indicates success of command execution.

Arguments
Returns

Promise.<void> –

OcaApplicationNetwork.GetErrorCode()

Retrieves the most recent error code. Return status indicates whether the operation was successful. Note that a second parameter ‘Reset’ is removed in v02 of this class.

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaApplicationNetwork.GetLabel()

Gets the network’s user-specified label. Return status indicates whether the operation was successful.

Returns

Promise.<string> – A promise which resolves to a single value of type string.

OcaApplicationNetwork.GetOwner()

Gets the ONo of this network’s containing block. Return status indicates whether the operation was successful.

Returns

Promise.<number> – A promise which resolves to a single value of type number.

OcaApplicationNetwork.GetPath()

Returns path from given object down to root. The return value indicates whether the operation succeeded. The return values of this method are

  • NamePath of type string[]

  • ONoPath of type number[]

Returns

Promise.<Arguments.<Array.<string>, Array.<number>>> –

OcaApplicationNetwork.GetServiceID()

Gets the network’s IDAdvertised. Return status indicates whether the operation was successful.

Returns

Promise.<Uint8Array> – A promise which resolves to a single value of type Uint8Array.

OcaApplicationNetwork.GetState()

Retrieves the network’s state. Return status indicates whether the status was successfully retrieved.

Returns

Promise.<OcaApplicationNetworkState> – A promise which resolves to a single value of type OcaApplicationNetworkState().

OcaApplicationNetwork.GetSystemInterfaces()

Retrieves the list of this network’s system interface descriptor. Return status indicates whether the list was successfully retrieved.

Returns

Promise.<Array.<OcaNetworkSystemInterfaceDescriptor>> – A promise which resolves to a single value of type OcaNetworkSystemInterfaceDescriptor[].

OcaApplicationNetwork.SetLabel(Label)

Sets the network’s user-specified label. Return status indicates whether the operation was successful.

Arguments

  • Label (string) –

Returns

Promise.<void> –

OcaApplicationNetwork.SetServiceID(Name)

Sets the network’s IDAdvertised. Return status indicates whether the operation was successful.

Arguments

  • Name (Uint8Array) –

Returns

Promise.<void> –

OcaApplicationNetwork.SetSystemInterfaces(Descriptors)

Sets the network’s System Interface Descriptor(s). Return status indicates whether the operation was successful. Optional method; System Interface Descriptor may be set at construction time.

Arguments

  • Descriptors (Array.<OcaNetworkSystemInterfaceDescriptor>) –

Returns

Promise.<void> –