1.2.10 OcaStreamNetwork

Class Hierarchy:

OcaRoot → OcaAgent → OcaStreamNetwork

class OcaStreamNetwork : OcaAgent

DEPRECATED CLASS Replaced by class **OcaMediaTransportNetwork ** in version 3 of Connection Management (CM3) Abstract base class for defining network classes to which this device belongs. May be a media transport network, a control and monitoring network, or a network that does both. There shall be one OcaStreamNetwork instance for each network to which the device belongs. This class may be subclassed to support networks of various types.

Properties:

static const OcaClassID ClassID = "1.2.10"

This property is an override of the OcaRoot property.

This property has id 3.1.

static const OcaClassVersionNumber ClassVersion = 2

This property is an override of the OcaRoot property.

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.

OcaNetworkNodeID IDAdvertised

ID by which this device is known on the network, i.e. the host name or GUID that this device publishes in the network’s directory/discovery system.

This property has id 3.2.

const 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.

OcaNetworkMediaProtocol MediaProtocol

Type of media transport protocol used by the network, or NONE if this network is not used for media transport.

This property has id 3.4.

OcaList<OcaONo> SignalChannelsSink

List of object numbers of _sink_ OcaNetworkSignalChannel objects collected by this network.

This property has id 3.10.

OcaList<OcaONo> SignalChannelsSource

List of object numbers of _source_ OcaNetworkSignalChannel objects collected by this network.

This property has id 3.9.

OcaNetworkStatistics Statistics

Error statistics for this network

This property has id 3.11.

OcaNetworkStatus Status

Operational status of the network.

This property has id 3.5.

OcaList<OcaONo> StreamConnectorsSink

List of object numbers of _sink_ OcaStreamConnector objects collected by this network.

This property has id 3.8.

OcaList<OcaONo> StreamConnectorsSource

List of object numbers of _source_ OcaStreamConnector objects collected by this network.

This property has id 3.7.

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.

Properties inherited from OcaAgent:

• OcaString OcaAgent::Label

• OcaONo OcaAgent::Owner

Properties inherited from OcaRoot:

• OcaONo OcaRoot::ObjectNumber

• OcaBoolean OcaRoot::Lockable

• OcaString OcaRoot::Role

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(OcaNetworkNodeID &Name)

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

This method has id 3.2.

Parameters

OcaNetworkNodeID Name – Output parameter.

OcaStatus SetIDAdvertised(OcaNetworkNodeID Name)

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

This method has id 3.3.

Parameters

OcaNetworkNodeID 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. Return status indicates whether the operation was successful.

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 GetStreamConnectorsSource(OcaList<OcaONo> &StreamConnectors)

Gets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.11.

Parameters

OcaList<OcaONo> StreamConnectors – Output parameter.

OcaStatus SetStreamConnectorsSource(OcaList<OcaONo> StreamConnectors)

Sets the list of object numbers of Source OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.12.

Parameters

OcaList<OcaONo> StreamConnectors – Input parameter.

OcaStatus GetStreamConnectorsSink(OcaList<OcaONo> &StreamConnectors)

Gets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.13.

Parameters

OcaList<OcaONo> StreamConnectors – Output parameter.

OcaStatus SetStreamConnectorsSink(OcaList<OcaONo> StreamConnectors)

Sets the list of object numbers of Sink OcaStreamConnector objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaStreamConnector objects’ Owner properties are updated, or when OcaStreamConnector objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.14.

Parameters

OcaList<OcaONo> StreamConnectors – Input parameter.

OcaStatus GetSignalChannelsSource(OcaList<OcaONo> &SignalChannels)

Gets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.15.

Parameters

OcaList<OcaONo> SignalChannels – Output parameter.

OcaStatus SetSignalChannelsSource(OcaList<OcaONo> SignalChannels)

Sets the list of object numbers of Source OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.16.

Parameters

OcaList<OcaONo> SignalChannels – Input parameter.

OcaStatus GetSignalChannelsSink(OcaList<OcaONo> &SignalChannels)

Gets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.17.

Parameters

OcaList<OcaONo> SignalChannels – Output parameter.

OcaStatus SetSignalChannelsSink(OcaList<OcaONo> SignalChannels)

Sets the list of object numbers of Sink OcaNetworkSignalChannel objects owned by this network. Return status indicates success of the operation. If the value of the network’s MediaProtocol property is NONE, this method will return the status value InvalidRequest. Members are added to and deleted from this list when OcaNetworkSignalChannel objects’ Owner properties are updated, or when OcaNetworkSignalChannel objects are deleted. For reconfigurable devices, such changes may be initiated by controllers during device operation.

This method has id 3.18.

Parameters

OcaList<OcaONo> SignalChannels – Input parameter.

OcaStatus Startup()

Start up this network.

This method has id 3.19.

OcaStatus Shutdown()

Shut down this network.

This method has id 3.20.

Methods inherited from OcaAgent:

• OcaAgent::GetLabel(Label)

• OcaAgent::SetLabel(Label)

• OcaAgent::GetOwner(owner)

• OcaAgent::GetPath(NamePath, ONoPath)

Methods inherited from OcaRoot:

• OcaRoot::GetClassIdentification(ClassIdentification)

• OcaRoot::GetLockable(lockable)

• OcaRoot::LockTotal()

• OcaRoot::Unlock()

• OcaRoot::GetRole(Role)

• OcaRoot::LockReadonly()