FMLiveSwitchStunRealmAttribute Class Reference

The REALM attribute may be present in requests and responses. More...

Instance Methods

(NSString *) - description
 Returns a string that represents this instance. More...
 
(int) - getValueLength
 Gets the length of the attribute value. More...
 
(instancetype) - initWithValue:
 Initializes a new instance of the FMLiveSwitchStunRealmAttribute class. More...
 
(void) - setValue:
 Sets the realm value. More...
 
(int) - typeValue
 Gets the type value. More...
 
(NSString *) - value
 Gets the realm 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

(FMLiveSwitchStunRealmAttribute *) + readValueFromWithBuffer:offset:length:
 Initializes a new instance of the FMLiveSwitchStunRealmAttribute class. More...
 
(FMLiveSwitchStunRealmAttribute *) + realmAttribute:
 Initializes a new instance of the FMLiveSwitchStunRealmAttribute 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 REALM attribute may be present in requests and responses.

It contains text that meets the grammar for "realm-value" as described in RFC 3261 [RFC3261] but without the double quotes and their surrounding whitespace. That is, it is an unquoted realm-value (and is therefore a sequence of qdtext or quoted-pair). It MUST be a UTF-8 [RFC3629] encoded sequence of less than 128 characters (which can be as long as 763 bytes), and MUST have been processed using SASLprep [RFC4013].

Method Documentation

◆ description

- (NSString*) description

Returns a string that represents this instance.

Returns
A string that represents this instance.

◆ getValueLength

- (int) getValueLength

Gets the length of the attribute value.

Implements FMLiveSwitchStunAttribute.

◆ initWithValue:

- (instancetype) initWithValue: (NSString *)  value

Initializes a new instance of the FMLiveSwitchStunRealmAttribute class.

Parameters
valueThe realm value.

◆ readValueFromWithBuffer:offset:length:

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

Initializes a new instance of the FMLiveSwitchStunRealmAttribute class.

Parameters
bufferThe buffer.
offsetThe offset.
lengthThe length.

◆ realmAttribute:

+ (FMLiveSwitchStunRealmAttribute*) realmAttribute: (NSString *)  value

Initializes a new instance of the FMLiveSwitchStunRealmAttribute class.

Parameters
valueThe realm value.

◆ setValue:

- (void) setValue: (NSString *)  value

Sets the realm value.

◆ typeValue

- (int) typeValue

Gets the type value.

Implements FMLiveSwitchStunAttribute.

◆ value

- (NSString*) value

Gets the realm value.

◆ writeValueToWithBuffer:offset:

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

Writes the attribute value to a data buffer.

Parameters
bufferThe buffer.
offsetThe offset.

Implements FMLiveSwitchStunAttribute.