1.2.1 OcaNetwork

Class Hirarchy:

OcaRootOcaAgentOcaNetwork

class OcaNetwork : OcaAgent

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.

Properties:

OcaClassID ClassID

This property is an override of the OcaRoot property.

This property has id 3.1.

OcaClassVersionNumber ClassVersion

This property is an override of the OcaRoot property.

This property has id 3.2.

OcaNetworkLinkType LinkType

Network link type - e.g. wired Ethernet, USB, … See the OcaNetworkType enum for details. This is a read-only property whose value is fixed to the class that is inherited from OcaNetwork to implement each specific type of network.

This property has id 3.1.

OcaApplicationNetworkServiceID IDAdvertised

ID by which this network object is known on the network, i.e. the name or GUID that this network object publishes in the network’s directory/discovery system. As of OCA 1.4, this description has been clarified to indicate this property is the registered service name, which 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.

This property has id 3.2.

OcaNetworkControlProtocol ControlProtocol

Type of control protocol used by the network (OCAnn) or NONE if this network is not used for control.

This property has id 3.3.

OcaNetworkMediaProtocol MediaProtocol

Deprecated property. Always has value NONE. Media transport is managed by the OcaStreamNetwork class.

This property has id 3.4.

OcaNetworkStatus Status

Operational status of the network.

This property has id 3.5.

OcaList<OcaNetworkSystemInterfaceID> SystemInterfaces

Collection of identifiers of system interface(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 identifier format is system and network dependent; for OCA purposes, it is maintained as a variable-length blob which the protocol does not inspect.

This property has id 3.6.

OcaList<OcaONo> MediaPorts

Deprecated property. Always is empty. Media transport is now managed by the class OcaStreamNetwork.

This property has id 3.7.

OcaNetworkStatistics Statistics

Error statistics for this network

This property has id 3.8.

Properties inherited from OcaAgent:

Properties inherited from OcaRoot:

Methods:

OcaStatus GetLinkType(OcaNetworkLinkType &Type)

Gets the network’s link type (wired Ethernet, USB, etc.). Return status indicates whether the operation was successful.

This method has id 3.1.

Parameters

OcaNetworkLinkType Type – Output parameter.

OcaStatus GetIDAdvertised(OcaApplicationNetworkServiceID &Name)

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

This method has id 3.2.

Parameters

OcaApplicationNetworkServiceID Name – Output parameter.

OcaStatus SetIDAdvertised(OcaApplicationNetworkServiceID Name)

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

This method has id 3.3.

Parameters

OcaApplicationNetworkServiceID Name – Input parameter.

OcaStatus GetControlProtocol(OcaNetworkControlProtocol &Protocol)

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

This method has id 3.4.

Parameters

OcaNetworkControlProtocol Protocol – Output parameter.

OcaStatus GetMediaProtocol(OcaNetworkMediaProtocol &Protocol)

Gets the network’s MediaProtocol property. This is a deprecated method that always returns the value NONE.

This method has id 3.5.

Parameters

OcaNetworkMediaProtocol Protocol – Output parameter.

OcaStatus GetStatus(OcaNetworkStatus &Status)

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

This method has id 3.6.

Parameters

OcaNetworkStatus Status – Output parameter.

OcaStatus GetStatistics(OcaNetworkStatistics &Status)

Retrieves network error statistics counter values. Return status indicates whether the values were successfully retrieved.

This method has id 3.7.

Parameters

OcaNetworkStatistics Status – Output parameter.

OcaStatus ResetStatistics()

Resets network error statistics counters. Return status indicates whether the counters were successfully reset.

This method has id 3.8.

OcaStatus GetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> &Interfaces)

Gets the list of system interface IDs that this network is using. Return status indicates success of the operation.

This method has id 3.9.

Parameters

OcaList<OcaNetworkSystemInterfaceID> Interfaces – Output parameter.

OcaStatus SetSystemInterfaces(OcaList<OcaNetworkSystemInterfaceID> Interfaces)

Sets the list of system interface IDs that this network will use. Return status indicates success of the operation. This method is not implemented by all network implementations.

This method has id 3.10.

Parameters

OcaList<OcaNetworkSystemInterfaceID> Interfaces – Input parameter.

OcaStatus GetMediaPorts(OcaList<OcaONo> &Ports)

Deprecated method. Always returns status INVALID_REQUEST. Media transport is now managed by the class OcaStreamNetwork.

This method has id 3.11.

Parameters

OcaList<OcaONo> Ports – Output parameter.

OcaStatus Startup()

Start up this network.

This method has id 3.12.

OcaStatus Shutdown()

Shut down this network.

This method has id 3.13.

Methods inherited from OcaAgent:

Methods inherited from OcaRoot: