1.2.11 OcaStreamConnector

Class Hierarchy:

class OcaStreamConnector : OcaAgent 

DEPRECATED CLASS Replaced by the OcaMediaSinkConnector ** *and* **OcaMediaSourceConnector ** *datatypes in version 3 of Connection Management (CM3)* Agent class for objects (“connectors”) that allow connection of streams to the device. Streams may be single channels or multichannel groups. A connector is either a *source* or a *sink.* Sources are sometimes called “talkers”. Sinks are sometimes called “listeners”. Each connector links to zero or more **OcaStream data objects. Each OcaStream object represents a signal flow to or from a local connector to a remote connector. The remote connector is usually, but not necessarily, in a different node. Each connector collects zero or more signal channels . A signal channel is an instance of OcaNetworkSignalChannel. Each signal channel exposes one media channel of the stream to the interior of the device. A signal channel therefore is a Worker that contains exactly one OcaPort data object. Each OcaStreamConnector object belongs to a particular instance of OcaStreamNetwork or a subclass of OcaStreamNetwork . Each OcaStreamConnector is linked to its network through the Owner property.

When a controller creates an OcaStreamConnector object dynamically, the controller must store the Object Number of the corresponding OcaStreamNetwork object in the Owner property.

Upon receiving the Owner property change, the OcaStreamConnector object must register itself with the given stream network object via some internal means.

This class may be subclassed to support various network types.

Properties:

static const OcaClassID ClassID = "1.2.11"

ID of this class

This property has id 3.1.

static const OcaClassVersionNumber ClassVersion = 2

Version number of this class

This property has id 3.2.

OcaStreamConnectorID IDAdvertised

Character name or binary identifier of this connector. This ID is advertised on the network to be found by other devices’ discovery processes.

This property has id 3.2.

OcaONo OwnerNetwork

Object number of stream network object ( OcaStreamNetwork or one of its subclasses) to which this connector belongs. In reconfigurable devices, a controller that creates an OcaStreamConnector object must store the appropriate stream network object number into this property. It is assumed that, upon receiving a value into its Owner property, the terminus object will by internal means register itself with the identified stream network.

This property has id 3.1.

OcaMap<OcaStreamConnectorPinIndex, OcaONo> Pins

The map of connector pin indexes to OcaNetworkSignalChannel[Source|Sink] objects collected by this connector. The pin indexes are _fixed indexes_ 1 to n, where n is the number of channels the connector accommodates (determined when the connector is created). If a certain pin in the connector is currently not attached the OcaONo of that index is 0.

This property has id 3.5.

OcaNetworkMediaSourceOrSink SourceOrSink

Specifies whether this connector is for output (source) or input (sink) signal channels.

This property has id 3.3.

OcaStreamConnectorStatus Status

Status of this terminus.

This property has id 3.6.

OcaMap<OcaStreamIndex, OcaStream> Streams

The list of OcaStream data objects contained in (i.e. connected to) this connector.

This property has id 3.4.

Properties inherited from OcaAgent:

Properties inherited from OcaRoot:

Methods:

OcaStatus ConnectStream(OcaStream Stream, OcaStreamIndex &Index)

Connects a stream to this connector. Return status indicates success of operation.

This method has id 3.7.

Parameters

OcaStream Stream – Input parameter.
OcaStreamIndex Index – Output parameter.

OcaStatus DisconnectStream(OcaStreamIndex StreamID)

Disconnects a stream from this connector. Return status indicates success of operation.

This method has id 3.8.

Parameters: OcaStreamIndex StreamID – Input parameter.

OcaStatus GetIDAdvertised(OcaStreamConnectorID &IDAdvertised)

Gets the value of the IDAdvertised property. Return status indicates success of operation.

This method has id 3.3.

Parameters: OcaStreamConnectorID IDAdvertised – Output parameter.

OcaStatus GetOwnerNetwork(OcaONo &Network)

Gets the object number of the OcaStreamNetwork object to which this connector belongs. Return status indicates success of operation.

This method has id 3.1.

Parameters: OcaONo Network – Output parameter.

OcaStatus GetPins(OcaMap<OcaStreamConnectorPinIndex, OcaONo> &Pins)

Gets the list of object numbers of OcaNetworkSignalChannel objects connected to this connector. Return status indicates success of operation.

This method has id 3.10.

Parameters: OcaMap<OcaStreamConnectorPinIndex, OcaONo> Pins – Output parameter.

OcaStatus GetSourceOrSink(OcaNetworkMediaSourceOrSink &SourceOrSink)

Gets the value of the SourceOrSink property. Return status indicates success of operation.

This method has id 3.5.

Parameters: OcaNetworkMediaSourceOrSink SourceOrSink – Output parameter.

OcaStatus GetStatus(OcaStreamConnectorStatus &Status)

Gets the value of the Status property. Return status indicates success of operation.

This method has id 3.11.

Parameters: OcaStreamConnectorStatus Status – Output parameter.

OcaStatus GetStreams(OcaMap<OcaStreamIndex, OcaStream> &Streams)

Gets the map of OcaStream items connected to this connector. Return status indicates success of operation.

This method has id 3.9.

Parameters: OcaMap<OcaStreamIndex, OcaStream> Streams – Output parameter.

OcaStatus SetIDAdvertised(OcaStreamConnectorID IDAdvertised)

Sets the value of the IDAdvertised property. Return status indicates success of operation.

This method has id 3.4.

Parameters: OcaStreamConnectorID IDAdvertised – Input parameter.

OcaStatus SetOwnerNetwork(OcaONo Network)

Sets the object number of the OcaStreamNetwork object to which this connector belongs. Return status indicates success of operation. Only implemented for reconfigurable devices.

This method has id 3.2.

Parameters: OcaONo Network – Input parameter.

OcaStatus SetSourceOrSink(OcaNetworkMediaSourceOrSink SourceOrSink)

Sets the value of the SourceOrSink property. Return status indicates success of operation. Only implemented for reconfigurable devices. Note that this method can only be called when the SignalChannels property is empty, i.e. does not contain any actual channels.

This method has id 3.6.

Parameters: OcaNetworkMediaSourceOrSink SourceOrSink – Input parameter.

Methods inherited from OcaAgent:

Methods inherited from OcaRoot: