FMLiveSwitchStunError Class Reference

Common functionality of various STUN/TURN server exceptions that occur while processing Allocation and Binding requests. More...

Instance Methods

(instancetype) - initWithCode:message:
 Initializes a new instance of the FMLiveSwitchStunError class. More...
 
(int) - stunCode
 Gets the STUN code. More...
 
(int) - stunErrorCode
 Gets the STUN code. More...
 
- Instance Methods inherited from FMLiveSwitchError
(FMLiveSwitchErrorCode) - code
 Gets the code. More...
 
(int) - codeValue
 Gets the code. More...
 
(NSString *) - description
 Returns the string representation of this error. More...
 
(FMLiveSwitchErrorCode) - errorCode
 Gets the code. More...
 
(NSException *) - exception
 Gets the exception. More...
 
(NSString *) - getDescription
 Gets the description for this FMLiveSwitchError. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchError class. More...
 
(instancetype) - initWithCode:exception:
 Initializes a new instance of the FMLiveSwitchError class. More...
 
(NSString *) - message
 Gets the message. More...
 
(void) - setCode:
 Sets the code. More...
 
(void) - setCodeValue:
 Sets the code. More...
 
(void) - setErrorCode:
 Sets the code. More...
 
(void) - setException:
 Sets the exception. More...
 
(void) - setMessage:
 Sets the message. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 

Class Methods

(FMLiveSwitchError *) + createStunErrorWithCode:message:
 Creates error for the given error code and with a given message. More...
 
(FMLiveSwitchStunError *) + errorWithCode:message:
 Initializes a new instance of the FMLiveSwitchStunError class. More...
 
- Class Methods inherited from FMLiveSwitchError
(FMLiveSwitchError *) + error
 Initializes a new instance of the FMLiveSwitchError class. More...
 
(FMLiveSwitchError *) + errorWithCode:exception:
 Initializes a new instance of the FMLiveSwitchError class. More...
 
(FMLiveSwitchError *) + fromJsonWithErrorJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + toJsonWithError:
 Serializes an instance to JSON. More...
 

Detailed Description

Common functionality of various STUN/TURN server exceptions that occur while processing Allocation and Binding requests.

Method Documentation

◆ createStunErrorWithCode:message:

+ (FMLiveSwitchError*) createStunErrorWithCode: (int)  code
message: (FMLiveSwitchStunMessage *)  message 

Creates error for the given error code and with a given message.

Parameters
codeThe error code.
messageThe error message.

◆ errorWithCode:message:

+ (FMLiveSwitchStunError*) errorWithCode: (FMLiveSwitchErrorCode)  code
message: (NSString *)  message 

Initializes a new instance of the FMLiveSwitchStunError class.

Parameters
codeThe error code.
messageThe error message.

Implements FMLiveSwitchError.

◆ initWithCode:message:

- (instancetype) initWithCode: (FMLiveSwitchErrorCode)  code
message: (NSString *)  message 

Initializes a new instance of the FMLiveSwitchStunError class.

Parameters
codeThe error code.
messageThe error message.

Implements FMLiveSwitchError.

◆ stunCode

- (int) stunCode

Gets the STUN code.

◆ stunErrorCode

- (int) stunErrorCode

Gets the STUN code.

Deprecated:
Use StunCode instead.