FMLiveSwitchDataStreamBase Class Reference

Data stream base properties/methods. More...

Instance Methods

(void) - attachToChannel:
 Attaches a data channel to this stream (events and IDs). More...
 
(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(NSString *) - canonicalName
 Gets the canonical name. More...
 
(FMLiveSwitchError *) - changeDirectionWithNewDirection:
 Changes this stream's direction. More...
 
(NSMutableArray *) - channels
 Gets the channels. More...
 
(FMLiveSwitchStreamDirection) - direction
 Gets the current direction. More...
 
(FMLiveSwitchDataStreamInfo *) - info
 Gets the data stream info. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchDataStreamBase`1 class. More...
 
(NSString *) - label
 Gets a label that identifies this class. More...
 
(FMLiveSwitchStreamDirection) - localDirection
 Gets the current direction. More...
 
(long long) - messagesReceived
 Gets the number of messages received. More...
 
(long long) - messagesSent
 Gets the number of messages sent. More...
 
(void) - processStateChange
 Processes a state change. More...
 
(void) - processStateLockChange
 Processes a state lock change. More...
 
(void) - registerDataReceivedWithDataLength:
 Registers that a data has been received. More...
 
(void) - registerDataSentWithDataLength:
 Registers that a data has been received. More...
 
(FMLiveSwitchStreamDirection) - remoteDirection
 Gets the current direction. More...
 
(void) - setLocalDirection:
 Sets the current direction. More...
 

Class Methods

(FMLiveSwitchDataStreamBase *) + dataStreamBase
 Initializes a new instance of the FMLiveSwitchDataStreamBase`1 class. More...
 

Protected Attributes

 __pad0__: FMLiveSwitchStream<FMLiveSwitchIDataStream
 

Detailed Description

Data stream base properties/methods.

Method Documentation

◆ attachToChannel:

- (void) attachToChannel: (TDataChannel)  channel

Attaches a data channel to this stream (events and IDs).

Parameters
channel

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ canonicalName

- (NSString*) canonicalName

Gets the canonical name.

Getting the value of DataStream.CanonicalName is deprecated and will be removed in a future release.

◆ changeDirectionWithNewDirection:

- (FMLiveSwitchError*) changeDirectionWithNewDirection: (FMLiveSwitchStreamDirection)  newDirection

Changes this stream's direction.

◆ channels

- (NSMutableArray*) channels

Gets the channels.

Implemented in FMLiveSwitchDataStream.

◆ dataStreamBase

+ (FMLiveSwitchDataStreamBase*) dataStreamBase

Initializes a new instance of the FMLiveSwitchDataStreamBase`1 class.

◆ direction

- (FMLiveSwitchStreamDirection) direction

Gets the current direction.

◆ info

Gets the data stream info.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchDataStreamBase`1 class.

◆ label

- (NSString*) label

Gets a label that identifies this class.

◆ localDirection

- (FMLiveSwitchStreamDirection) localDirection

Gets the current direction.

◆ messagesReceived

- (long long) messagesReceived

Gets the number of messages received.

◆ messagesSent

- (long long) messagesSent

Gets the number of messages sent.

◆ processStateChange

- (void) processStateChange

Processes a state change.

◆ processStateLockChange

- (void) processStateLockChange

Processes a state lock change.

◆ registerDataReceivedWithDataLength:

- (void) registerDataReceivedWithDataLength: (int)  dataLength

Registers that a data has been received.

Parameters
dataLengthThe data length.

◆ registerDataSentWithDataLength:

- (void) registerDataSentWithDataLength: (int)  dataLength

Registers that a data has been received.

Parameters
dataLengthThe data length.

◆ remoteDirection

- (FMLiveSwitchStreamDirection) remoteDirection

Gets the current direction.

◆ setLocalDirection:

- (void) setLocalDirection: (FMLiveSwitchStreamDirection)  value

Sets the current direction.

Member Data Documentation

◆ __pad0__

- __pad0__
protected