Deprecated CM2 Datatypes

OcaNetworkLinkType

enum OcaNetworkLinkType : uint8_t

Types of layer 2 networks.

enumerator None = 0: No network

enumerator EthernetWired = 1: Wired Ethernet

enumerator EthernetWireless = 2: Wireless Ethernet

enumerator USB = 3: USB

enumerator SerialP2P = 4: Low-speed serial point-to-point

OcaNetworkHostID

using OcaNetworkHostID = OcaBlob : ID (name or address) of network host found by the discovery process.

OcaNetworkNodeID

using OcaNetworkNodeID = OcaBlob : ID (name or GUID) of network node. There may be one or more nodes per host. Nodes offer media network services, and are what is discovered by discovery processes. Each instance of OcaNetwork (or one of its subclasses) is a node.

OcaStreamConnectorPinIndex

using OcaStreamConnectorPinIndex = OcaUint16 : An index of a pin of an OcaNetworkSignalChannel object. This is a CM2 class, deprecated as of OCA 1.4 .

OcaNetworkSystemInterfaceID

struct OcaNetworkSystemInterfaceID

ID of a system interface used by a network. Format is data network type dependent.

OcaBlob SystemInterfaceHandle: Operating system handle for the interface the network uses to do I/O.

OcaNetworkAddress MyNetworkAddress: The data network address that corresponds to this system interface.

OcaNetworkSignalChannelID

using OcaNetworkSignalChannelID = OcaBlob : External ID of a signal channel. Name or number, depending on transport architecture being used. This datatype is deprecated as of OCA 1.4

OcaNetworkStatistics

struct OcaNetworkStatistics

Historical statistics of the network.

OcaUint32 rxPacketErrors: The number of receiver packet errors.

OcaUint32 txPacketErrors: The number of transmitter packet errors.

OcaStreamConnectorID

using OcaStreamConnectorID = OcaBlob : Public ID of a network stream connector. Name or number, depending on transport architecture being used.

OcaStream

struct OcaStream

A single-channel or multichannel signal flow between a local stream connector (i.e. OcaStreamConnector instance) of an OcaStreamNetwork object in this node and another (“remote”) stream connector. Normally, the remote stream connector is in another node. Each stream is unidirectional. With respect to the OcaStreamNetwork object in question, a stream is either:

Outbound: * A signal flow from an output connector port in the **OcaStreamNetwork* object to an external destination; or

Inbound: * A signal flow from an external source to an *input connector in the OcaStreamNetwork object.

An OcaStream object may represent either a unicast or a multicast stream. Any given OcaStreamConnector object may support multiple outbound flows, but not multiple inbound flows.

OcaUint16 ErrorNumber: Index of most recent error encountered.

OcaStreamID IDAdvertised: Public identifier of this stream.

OcaStreamIndex Index: Index of this stream. Unique within owner OcaNetwork2 object.

OcaString Label: Arbitrary user-settable name for this stream.

OcaONo LocalConnectorONo: Object number of OcaStreamConnector object to which this stream is connected. A value of zero means the stream is not connected to any connector in this device.

OcaUint16 Priority: Traffic priority of stream. Values are network implementation dependant.

OcaStreamConnectorIdentification RemoteConnectorIdentification: Full identifier of the connector at the far end of this stream.

OcaBoolean Secure: True if and only if connection is secure.

OcaStreamStatus Status: Current status of the stream.

OcaStreamParameters StreamParameters: Stream parameters (encoding, sampling, etc). Details TBD

OcaStreamType StreamType: Unicast or multicast

OcaNetworkControlProtocol

enum OcaNetworkControlProtocol : uint8_t

Network control protocols available.

enumerator None = 0: No control protocol - the network does not do control.

enumerator OCP01 = 1: OCP.1 - OCA protocol for TCP/IP networks

enumerator OCP02 = 2: OCP.2 - OCA protocol for USB links.

enumerator OCP03 = 3: OCP.3 - Character XML or JSON (tbd) version of OCA protocol, for serial links and other purposes.

OcaStreamID

using OcaStreamID = OcaBlob : Public ID of a stream. Name or number, depending on transport architecture being used.

OcaStreamConnectorIdentification

struct OcaStreamConnectorIdentification

A signal source or sink connector at the far end of a stream - normally, in another device. Not all of the fields of this datatype need be used. The fields used will depend on remote device type, media transport network type, and media transport implementation. Normal usage scenarios are:

Unicast input or output: The OcaStream object is instantiated in an OcaStreamConnector object in the local device, and it links to an OcaStreamConnector object in a remote device.

Multicast input : The OcaStream object is instantiated in an OcaStreamConnector object in the local device, and, it may or may not link to an OcaStreamConnector object in a remote device.

Multicast output : The OcaStream object is instantiated in an OcaStreamConnector object in the local device, but in this case does not link to any specific remote connector object.

OcaNetworkHostID HostID: Public name or binary ID of host in which this connector resides.

OcaNetworkAddress NetworkAddress: Network address of host in which this connector resides.

OcaNetworkNodeID NodeID: Public name or binary ID of node within the host to which this connector belongs.

OcaStreamConnectorID StreamConnectorID: Public name or binary ID of this stream connector.

OcaStreamIndex

using OcaStreamIndex = OcaUint16 : Internal handle of a stream.

OcaNetworkStatus

enum OcaNetworkStatus : uint8_t

Network status enum.

enumerator Unknown = 0: Status is not known for some reason.

enumerator Ready = 1: Network is ready for data transfer.

enumerator StartingUp = 2: Network is starting up.

enumerator Stopped = 3: Network has been stopped by a call to the Stop() method. All media connections and/or control sessions have been closed.

OcaStreamConnectorStatus

enum OcaStreamConnectorStatus : uint8_t

Status options for a stream connector.

enumerator NotAvailable = 0: Connector is not ready to transfer data.

enumerator Idle = 1: Connector is ready for data transfer but is not connected to any streams.

enumerator Connected = 2: Connector is connected to at least one stream.

enumerator Paused = 3: Connector is connected to at least one stream but data transfer has been halted by controller request.

OcaNetworkSignalChannelStatus

enum OcaNetworkSignalChannelStatus : uint8_t

Status options for a stream.

enumerator NotConnected = 0: Channel is not ready to transfer data.

enumerator Connected = 1: Channel is ready for data transfer.

enumerator Muted = 2: Channel is set up, but data transfer has been halted.

OcaNetworkMediaSourceOrSink

enum OcaNetworkMediaSourceOrSink : uint8_t

enum that describes whether a port is a source (= sends program into the network; “talker”) or sink (=receives program from the network; “listener”)

enumerator None = 0: Port direction is undefined.

enumerator Source = 1: Port is source (= talker)

enumerator Sink = 2: Port is sink (=listener)

OcaStreamType

enum OcaStreamType : uint8_t

Type of media endpoint: unicast or multicast.

enumerator None = 0: Unknown media endpoint type.

enumerator Unicast = 1: Unicast stream.

enumerator Multicast = 2: Multicast stream

OcaStreamStatus

enum OcaStreamStatus : uint8_t

Status options for a stream.

enumerator NotConnected = 0: Connection is not ready to transfer data.

enumerator Connected = 1: Connection is ready for data transfer.

enumerator Paused = 2: Connection is set up, but data transfer has been halted.