The ERROR-CODE attribute is used in error response messages. More...

Instance Methods
(int)	- code
	Gets the error code. More...

(NSString *)	- description
	Returns a string that represents this instance. More...

(int)	- getValueLength
	Gets the length of the attribute value. More...

(instancetype)	- initWithCode:
	Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class. More...

(instancetype)	- initWithCode:reason:
	Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class. More...

(NSString *)	- reason
	Gets the error reason. More...

(void)	- setCode:
	Sets the error code. More...

(void)	- setReason:
	Sets the error reason. More...

(int)	- typeValue
	Gets the type value. More...

(void)	- writeValueToWithBuffer:offset:
	Writes the attribute value to a data buffer. More...

Instance Methods inherited from FMLiveSwitchStunAttribute
(int)	- getLength
	Gets the length of the attribute, including header and padding. More...

(int)	- getPaddingLengthWithValueLength:
	Gets the length of the padding. More...

(instancetype)	- init

(void)	- writeIPAddressWithBuffer:offset:addressType:ipAddress:
	Writes an IP address. More...

(void)	- writePortWithBuffer:offset:port:
	Writes a port. More...

(void)	- writeToWithBuffer:offset:
	Writes the attribute to a data buffer. More...

(void)	- writeToWithBuffer:offset:offsetPlus:
	Writes the attribute to a data buffer. More...

(void)	- writeXorIPAddressWithBuffer:offset:addressType:ipAddress:transactionId:
	Writes an XOR'd IP address. More...

(void)	- writeXorPortWithBuffer:offset:port:transactionId:
	Writes an XOR'd port. More...

Class Methods
(FMLiveSwitchStunErrorCodeAttribute *)	+ errorCodeAttributeWithCode:
	Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class. More...

(FMLiveSwitchStunErrorCodeAttribute *)	+ errorCodeAttributeWithCode:reason:
	Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class. More...

(FMLiveSwitchStunErrorCodeAttribute *)	+ readValueFromWithBuffer:offset:length:
	Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class. More...

Class Methods inherited from FMLiveSwitchStunAttribute
(int)	+ alternateServerType
	Gets the ALTERNATE-SERVER type. More...

(FMLiveSwitchStunAttribute *)	+ attribute

(int)	+ channelNumberType
	Gets the CHANNEL-NUMBER type. More...

(int)	+ connectionIdType
	Gets the CONNECTION-ID type. More...

(int)	+ controlledType
	Gets the CONTROLLED type. More...

(int)	+ controllingType
	Gets the CONTROLLING type. More...

(int)	+ dataType
	Gets the DATA type. More...

(int)	+ dontFragmentType
	Gets the DONT-FRAGMENT type. More...

(int)	+ errorCodeType
	Gets the ERROR-CODE type. More...

(int)	+ evenPortType
	Gets the EVEN-PORT type. More...

(int)	+ fingerprintType
	Gets the FINGERPRINT type. More...

(int)	+ lifetimeType
	Gets the LIFETIME type. More...

(int)	+ mappedAddressType
	Gets the MAPPED-ADDRESS type. More...

(int)	+ messageIntegrityType
	Gets the MESSAGE-INTEGRITY type. More...

(int)	+ nextLengthWithBuffer:offset:
	Reads the length of the next attribute from a data buffer, including header and padding. More...

(int)	+ nonceType
	Gets the NONCE type. More...

(int)	+ priorityType
	Gets the PRIORITY type. More...

(FMLiveSwitchAddressType)	+ readAddressTypeWithBuffer:offset:
	Reads an address type. More...

(FMLiveSwitchStunAttribute *)	+ readFromWithBuffer:offset:offsetPlus:transactionId:messageBuffer:
	Reads an FMLiveSwitchStunAttribute from a data buffer. More...

(FMLiveSwitchStunAttribute *)	+ readFromWithBuffer:offset:transactionId:messageBuffer:
	Reads an FMLiveSwitchStunAttribute from a data buffer. More...

(NSString *)	+ readIPAddressWithBuffer:offset:addressType:
	Reads an IP address. More...

(int)	+ readPortWithBuffer:offset:
	Reads a port. More...

(NSString *)	+ readXorIPAddressWithBuffer:offset:addressType:transactionId:
	Reads an XOR'd IP address. More...

(int)	+ readXorPortWithBuffer:offset:transactionId:
	Reads an XOR'd port. More...

(int)	+ realmType
	Gets the REALM type. More...

(int)	+ requestedAddressFamilyType
	Gets the REQUESTED-ADDRESS-FAMILY type. More...

(int)	+ requestedTransportType
	Gets the REQUESTED-TRANSPORT type. More...

(int)	+ reservationTokenType
	Gets the RESERVATION-TOKEN type. More...

(int)	+ softwareType
	Gets the SOFTWARE type. More...

(int)	+ transactionTransmitCounterType
	Gets the comprehension-optional TRANSACTION_TRANSMIT_COUNTER type defined in RFC 7982. More...

(int)	+ unknownAttributesType
	Gets the UNKNOWN-ATTRIBUTES type. More...

(int)	+ useCandidateType
	Gets the USE-CANDIDATE type. More...

(int)	+ usernameType
	Gets the USERNAME type. More...

(void)	+ writeAddressTypeWithBuffer:offset:addressType:
	Writes an address type. More...

(int)	+ xorMappedAddressType
	Gets the XOR-MAPPED-ADDRESS type. More...

(int)	+ xorPeerAddressType
	Gets the XOR-PEER-ADDRESS type. More...

(int)	+ xorRelayedAddressType
	Gets the XOR-RELAYED-ADDRESS type. More...

Detailed Description

The ERROR-CODE attribute is used in error response messages.

It contains a numeric error code value in the range of 300 to 699 plus a textual reason phrase encoded in UTF-8 [RFC3629], and is consistent in its code assignments and semantics with SIP [RFC3261] and HTTP [RFC2616]. The reason phrase is meant for user consumption, and can be anything appropriate for the error code. Recommended reason phrases for the defined error codes are included in the IANA registry for error codes. The reason phrase MUST be a UTF-8 [RFC3629] encoded sequence of less than 128 characters (which can be as long as 763 bytes).

Method Documentation

◆ code

- (int) code

Gets the error code.

◆ description

- (NSString*) description

Returns a string that represents this instance.

Returns: A string that represents this instance.

◆ errorCodeAttributeWithCode:

+ (FMLiveSwitchStunErrorCodeAttribute*) errorCodeAttributeWithCode: (int) code

Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class.

Parameters

code	The error code.

◆ errorCodeAttributeWithCode:reason:

+ (FMLiveSwitchStunErrorCodeAttribute*) errorCodeAttributeWithCode:	(int)	code
reason:	(NSString *)	reason

Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class.

Parameters

code	The error code.
reason	The error reason.

◆ getValueLength

- (int) getValueLength

Gets the length of the attribute value.

Implements FMLiveSwitchStunAttribute.

◆ initWithCode:

- (instancetype) initWithCode: (int) code

Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class.

Parameters

code	The error code.

◆ initWithCode:reason:

- (instancetype) initWithCode:	(int)	code
reason:	(NSString *)	reason

Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class.

Parameters

code	The error code.
reason	The error reason.

◆ readValueFromWithBuffer:offset:length:

+ (FMLiveSwitchStunErrorCodeAttribute*) readValueFromWithBuffer:	(FMLiveSwitchDataBuffer *)	buffer
offset:	(int)	offset
length:	(int)	length

Initializes a new instance of the FMLiveSwitchStunErrorCodeAttribute class.

Parameters

buffer	The buffer.
offset	The offset.
length	The length.

◆ reason

- (NSString*) reason

Gets the error reason.

◆ setCode:

- (void) setCode: (int) value

Sets the error code.

◆ setReason:

- (void) setReason: (NSString *) value

Sets the error reason.

◆ typeValue

- (int) typeValue

Gets the type value.

Implements FMLiveSwitchStunAttribute.

◆ writeValueToWithBuffer:offset:

- (void) writeValueToWithBuffer:	(FMLiveSwitchDataBuffer *)	buffer
offset:	(int)	offset

Writes the attribute value to a data buffer.

Parameters

buffer	The buffer.
offset	The offset.

Implements FMLiveSwitchStunAttribute.

Instance Methods

Class Methods

Detailed Description

Method Documentation

◆ code

◆ description

◆ errorCodeAttributeWithCode:

◆ errorCodeAttributeWithCode:reason:

◆ getValueLength

◆ initWithCode:

◆ initWithCode:reason:

◆ readValueFromWithBuffer:offset:length:

◆ reason

◆ setCode:

◆ setReason:

◆ typeValue

◆ writeValueToWithBuffer:offset: