FMLiveSwitchIceTransport Class Reference

Instance Methods
(void)	- addOnActiveCandidatePairChange:
(FMLiveSwitchIceTransport *, FMLiveSwitchIceCandidatePair *)	- addOnActiveCandidatePairChangeWithBlock
(void)	- addOnActiveCandidatePairChangeWithBlock:
(void)	- addOnReceive:
	Adds a handler that is raised when data is received. More...
(FMLiveSwitchDataBuffer *)	- addOnReceiveWithBlock
	Adds a handler that is raised when data is received. More...
(void)	- addOnReceiveWithBlock:
	Adds a handler that is raised when data is received. More...
(void)	- addOnStateChange:
(FMLiveSwitchIceTransport *)	- addOnStateChangeWithBlock
(void)	- addOnStateChangeWithBlock:
(void)	- addRemoteCandidateWithNewSignalledCandidate:
(bool)	- closingShouldNotTriggerGlobalNonGracefulShutdown
(FMLiveSwitchIceComponent)	- component
(FMLiveSwitchIceTransport *)	- createRtcpTransport
(FMLiveSwitchError *)	- error
(FMLiveSwitchIceCandidate *)	- findMatchingRemoteCandidateWithIPAddress:port:
(FMLiveSwitchIceGatherer *)	- gatherer
(NSString *)	- getReceivedApplicationPayloadSummary
(NSString *)	- id
(instancetype)	- initWithLockObject:connectionId:scheduler:options:
(instancetype)	- initWithLockObject:connectionId:scheduler:options:context:
(bool)	- isClosed
	Gets a value indicating whether this instance is closed. More...
(int)	- lastRelayServerRoundTripTime
(int)	- lastRoundTripTime
(NSMutableArray *)	- localCandidates
(int)	- nextTransportSequenceNumber
	Gets the next Transport-Wide Sequence Number. More...
(NSMutableArray *)	- remoteCandidates
(FMLiveSwitchIceParameters *)	- remoteParameters
(void)	- removeOnActiveCandidatePairChange:
(void)	- removeOnReceive:
	Removes a handler that is raised when data is received. More...
(void)	- removeOnStateChange:
(void)	- removeRtcpTransport
(FMLiveSwitchIceRole)	- role
(int)	- roundTripTime
	Gets the current round-trip-time in milliseconds. More...
(void)	- sendWithBuffer:
	Sends the specified buffer. More...
(void)	- setClosingShouldNotTriggerGlobalNonGracefulShutdown:
(void)	- setSingleRemoteCandidateForIceBypass:
(void)	- setStateLedger:
(FMLiveSwitchIceCandidate *)	- singleRemoteCandidateForIceBypass
(int)	- smoothedRelayServerRoundTripTime
(int)	- smoothedRoundTripTime
(void)	- startCollectingReceivedApplicationData
(bool)	- startWithGatherer:remoteParameters:role:tieBreaker:
(FMLiveSwitchIceTransportState)	- state
(FMLiveSwitchConnectionStateLedger *)	- stateLedger
(bool)	- stop
(void)	- stopCollectingReceivedApplicationData
(void)	- updateInfo:
(void)	- updateStats:
Instance Methods inherited from FMLiveSwitchTransport
(instancetype)	- init
	Initializes a new instance of the FMLiveSwitchSerializable class. More...
Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *)	- dynamicProperties
	Gets all dynamic properties on this instance. More...
(id)	- getDynamicValueWithKey:
	Gets a property value from the local cache. More...
(void)	- setDynamicValueWithKey:value:
	Sets a property value in the local cache. More...
(bool)	- unsetDynamicValueWithKey:
	Removes a property value from the local cache. More...

Class Methods
(FMLiveSwitchIceTransport *)	+ transportWithLockObject:connectionId:scheduler:options:
(FMLiveSwitchIceTransport *)	+ transportWithLockObject:connectionId:scheduler:options:context:
Class Methods inherited from FMLiveSwitchTransport
(FMLiveSwitchTransport *)	+ transport
Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *)	+ dynamic
Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *)	+ serializable
	Initializes a new instance of the FMLiveSwitchSerializable class. More...

Method Documentation

addOnActiveCandidatePairChange:

- (void) addOnActiveCandidatePairChange:

(FMLiveSwitchAction2< FMLiveSwitchIceTransport *, FMLiveSwitchIceCandidatePair * > *)

value

addOnActiveCandidatePairChangeWithBlock

- (FMLiveSwitchIceTransport*, FMLiveSwitchIceCandidatePair*) addOnActiveCandidatePairChangeWithBlock

addOnActiveCandidatePairChangeWithBlock:

- (void) addOnActiveCandidatePairChangeWithBlock:

(void(^)(FMLiveSwitchIceTransport *, FMLiveSwitchIceCandidatePair *))

valueBlock

addOnReceive:

- (void) addOnReceive:

(FMLiveSwitchAction1< FMLiveSwitchDataBuffer * > *)

value

Adds a handler that is raised when data is received.

Implements FMLiveSwitchTransport.

addOnReceiveWithBlock

- (FMLiveSwitchDataBuffer*) addOnReceiveWithBlock

Adds a handler that is raised when data is received.

Implements FMLiveSwitchTransport.

addOnReceiveWithBlock:

- (void) addOnReceiveWithBlock:

(void(^)(FMLiveSwitchDataBuffer *))

valueBlock

Adds a handler that is raised when data is received.

Implements FMLiveSwitchTransport.

addOnStateChange:

- (void) addOnStateChange:

(FMLiveSwitchAction1< FMLiveSwitchIceTransport * > *)

value

addOnStateChangeWithBlock

- (FMLiveSwitchIceTransport*) addOnStateChangeWithBlock

addOnStateChangeWithBlock:

- (void) addOnStateChangeWithBlock:

(void(^)(FMLiveSwitchIceTransport *))

valueBlock

addRemoteCandidateWithNewSignalledCandidate:

- (void) addRemoteCandidateWithNewSignalledCandidate:

(FMLiveSwitchIceCandidate *)

newSignalledCandidate

closingShouldNotTriggerGlobalNonGracefulShutdown

- (bool) closingShouldNotTriggerGlobalNonGracefulShutdown

component

- (FMLiveSwitchIceComponent) component

createRtcpTransport

- (FMLiveSwitchIceTransport*) createRtcpTransport

error

- (FMLiveSwitchError*) error

findMatchingRemoteCandidateWithIPAddress:port:

- (FMLiveSwitchIceCandidate*) findMatchingRemoteCandidateWithIPAddress:		(NSString *)	ipAddress
port:		(int)	port

gatherer

- (FMLiveSwitchIceGatherer*) gatherer

getReceivedApplicationPayloadSummary

- (NSString*) getReceivedApplicationPayloadSummary

id

- (NSString*) id

initWithLockObject:connectionId:scheduler:options:

- (instancetype) initWithLockObject:		(id)	lockObject
connectionId:		(NSString *)	connectionId
scheduler:		(NSObject< FMLiveSwitchIScheduler > *)	scheduler
options:		(FMLiveSwitchIceTransportOptions *)	options

initWithLockObject:connectionId:scheduler:options:context:

- (instancetype) initWithLockObject:		(id)	lockObject
connectionId:		(NSString *)	connectionId
scheduler:		(NSObject< FMLiveSwitchIScheduler > *)	scheduler
options:		(FMLiveSwitchIceTransportOptions *)	options
context:		(FMLiveSwitchLogContext *)	context

isClosed

- (bool) isClosed

Gets a value indicating whether this instance is closed.

Implements FMLiveSwitchTransport.

lastRelayServerRoundTripTime

- (int) lastRelayServerRoundTripTime

lastRoundTripTime

- (int) lastRoundTripTime

localCandidates

- (NSMutableArray*) localCandidates

nextTransportSequenceNumber

- (int) nextTransportSequenceNumber

Gets the next Transport-Wide Sequence Number.

Values ranger between -2^16 and 2^16 and wrap around.

Implements FMLiveSwitchTransport.

remoteCandidates

- (NSMutableArray*) remoteCandidates

remoteParameters

- (FMLiveSwitchIceParameters*) remoteParameters

removeOnActiveCandidatePairChange:

- (void) removeOnActiveCandidatePairChange:

(FMLiveSwitchAction2< FMLiveSwitchIceTransport *, FMLiveSwitchIceCandidatePair * > *)

value

removeOnReceive:

- (void) removeOnReceive:

(FMLiveSwitchAction1< FMLiveSwitchDataBuffer * > *)

value

Removes a handler that is raised when data is received.

Implements FMLiveSwitchTransport.

removeOnStateChange:

- (void) removeOnStateChange:

(FMLiveSwitchAction1< FMLiveSwitchIceTransport * > *)

value

removeRtcpTransport

- (void) removeRtcpTransport

role

- (FMLiveSwitchIceRole) role

roundTripTime

- (int) roundTripTime

Gets the current round-trip-time in milliseconds.

Implements FMLiveSwitchTransport.

sendWithBuffer:

- (void) sendWithBuffer:

(FMLiveSwitchDataBuffer *)

buffer

Sends the specified buffer.

Parameters

buffer

The buffer.

Implements FMLiveSwitchTransport.

setClosingShouldNotTriggerGlobalNonGracefulShutdown:

- (void) setClosingShouldNotTriggerGlobalNonGracefulShutdown:

(bool)

value

setSingleRemoteCandidateForIceBypass:

- (void) setSingleRemoteCandidateForIceBypass:

(FMLiveSwitchIceCandidate *)

value

setStateLedger:

- (void) setStateLedger:

(FMLiveSwitchConnectionStateLedger *)

value

singleRemoteCandidateForIceBypass

- (FMLiveSwitchIceCandidate*) singleRemoteCandidateForIceBypass

smoothedRelayServerRoundTripTime

- (int) smoothedRelayServerRoundTripTime

smoothedRoundTripTime

- (int) smoothedRoundTripTime

startCollectingReceivedApplicationData

- (void) startCollectingReceivedApplicationData

startWithGatherer:remoteParameters:role:tieBreaker:

- (bool) startWithGatherer:		(FMLiveSwitchIceGatherer *)	gatherer
remoteParameters:		(FMLiveSwitchIceParameters *)	remoteParameters
role:		(FMLiveSwitchIceRole)	role
tieBreaker:		(long long)	tieBreaker

state

- (FMLiveSwitchIceTransportState) state

stateLedger

- (FMLiveSwitchConnectionStateLedger*) stateLedger

stop

- (bool) stop

stopCollectingReceivedApplicationData

- (void) stopCollectingReceivedApplicationData

transportWithLockObject:connectionId:scheduler:options:

+ (FMLiveSwitchIceTransport*) transportWithLockObject:		(id)	lockObject
connectionId:		(NSString *)	connectionId
scheduler:		(NSObject< FMLiveSwitchIScheduler > *)	scheduler
options:		(FMLiveSwitchIceTransportOptions *)	options

transportWithLockObject:connectionId:scheduler:options:context:

+ (FMLiveSwitchIceTransport*) transportWithLockObject:		(id)	lockObject
connectionId:		(NSString *)	connectionId
scheduler:		(NSObject< FMLiveSwitchIScheduler > *)	scheduler
options:		(FMLiveSwitchIceTransportOptions *)	options
context:		(FMLiveSwitchLogContext *)	context

updateInfo:

- (void) updateInfo:

(FMLiveSwitchTransportInfo *)

info

updateStats:

- (void) updateStats:

(FMLiveSwitchTransportStats *)

stats