FMLiveSwitchDataChannelStats Class Reference

Data channel stats. More...

Instance Methods

(long long) - bytesReceived
 Gets the number of bytes received. More...
 
(long long) - bytesSent
 Gets the number of bytes sent. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(instancetype) - init
 Initializes a new instance of FMLiveSwitchDataChannelStats. More...
 
(NSString *) - label
 Gets the label. More...
 
(long long) - messagesReceived
 Gets the number of messages received. More...
 
(long long) - messagesSent
 Gets the number of messages sent. More...
 
(bool) - ordered
 Gets whether the channel is ordered. More...
 
(NSString *) - protocol
 Gets the protocol. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(FMLiveSwitchDataChannelState) - state
 Gets the state. More...
 
(NSString *) - toJson
 Serializes this to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchBaseStats
(NSString *) - id
 Gets the identifier of the object generating these stats. More...
 
(NSDate *) - timestamp
 Gets the timestamp when these stats were generated. More...
 

Class Methods

(FMLiveSwitchDataChannelStats *) + dataChannelStats
 Initializes a new instance of FMLiveSwitchDataChannelStats. More...
 
(NSMutableArray *) + fromJsonArrayWithDataChannelsJson:
 Derializes an array of data channel stats from JSON. More...
 
(FMLiveSwitchDataChannelStats *) + fromJsonWithDataChannelJson:
 Derializes data channel stats from JSON. More...
 
(NSString *) + toJsonArrayWithDataChannels:
 Serializes an array of data channel stats to JSON. More...
 
(NSString *) + toJsonWithDataChannel:
 Serializes data channel stats to JSON. More...
 
- Class Methods inherited from FMLiveSwitchBaseStats
(FMLiveSwitchBaseStats *) + baseStats
 

Detailed Description

Data channel stats.

Method Documentation

◆ bytesReceived

- (long long) bytesReceived

Gets the number of bytes received.

◆ bytesSent

- (long long) bytesSent

Gets the number of bytes sent.

◆ dataChannelStats

+ (FMLiveSwitchDataChannelStats*) dataChannelStats

Initializes a new instance of FMLiveSwitchDataChannelStats.

◆ deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey: (NSString *)  key
valueJson: (NSString *)  valueJson 

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchBaseStats.

◆ fromJsonArrayWithDataChannelsJson:

+ (NSMutableArray*) fromJsonArrayWithDataChannelsJson: (NSString *)  dataChannelsJson

Derializes an array of data channel stats from JSON.

Parameters
dataChannelsJsonThe data channels' stats JSON.

◆ fromJsonWithDataChannelJson:

+ (FMLiveSwitchDataChannelStats*) fromJsonWithDataChannelJson: (NSString *)  dataChannelJson

Derializes data channel stats from JSON.

Parameters
dataChannelJsonThe data channel's stats JSON.

◆ init

- (instancetype) init

Initializes a new instance of FMLiveSwitchDataChannelStats.

Implements FMLiveSwitchBaseStats.

◆ label

- (NSString*) label

Gets the label.

◆ messagesReceived

- (long long) messagesReceived

Gets the number of messages received.

◆ messagesSent

- (long long) messagesSent

Gets the number of messages sent.

◆ ordered

- (bool) ordered

Gets whether the channel is ordered.

◆ protocol

- (NSString*) protocol

Gets the protocol.

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *)  jsonObject

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchBaseStats.

◆ state

- (FMLiveSwitchDataChannelState) state

Gets the state.

◆ toJson

- (NSString*) toJson

Serializes this to JSON.

◆ toJsonArrayWithDataChannels:

+ (NSString*) toJsonArrayWithDataChannels: (NSMutableArray *)  dataChannels

Serializes an array of data channel stats to JSON.

Parameters
dataChannelsThe data channels' stats.

◆ toJsonWithDataChannel:

+ (NSString*) toJsonWithDataChannel: (FMLiveSwitchDataChannelStats *)  dataChannel

Serializes data channel stats to JSON.

Parameters
dataChannelThe data channel's stats.