FMLiveSwitchStunMappedAddressAttribute Class Reference

The MAPPED-ADDRESS attribute indicates a reflexive transport address of the client. More...

Instance Methods

(NSString *) - description
 Returns a string that represents this instance. More...
 
(int) - getValueLength
 Gets the length of the value. More...
 
(instancetype) - initWithIPAddress:port:
 Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute class. More...
 
(NSString *) - ipAddress
 Gets the IP address. More...
 
(int) - port
 Gets the port. More...
 
(void) - setIPAddress:
 Sets the IP address. More...
 
(void) - setPort:
 Sets the port. More...
 
(int) - typeValue
 Gets the type value. More...
 
(void) - writeValueToWithBuffer:offset:
 Writes the value to. 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

(FMLiveSwitchStunMappedAddressAttribute *) + mappedAddressAttributeWithIPAddress:port:
 Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute class. More...
 
(FMLiveSwitchStunMappedAddressAttribute *) + readValueFromWithBuffer:offset:
 Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute 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 MAPPED-ADDRESS attribute indicates a reflexive transport address of the client.

It consists of an 8-bit address family and a 16-bit port, followed by a fixed-length value representing the IP address. If the address family is IPv4, the address MUST be 32 bits. If the address family is IPv6, the address MUST be 128 bits. All fields must be in network byte order.

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 value.

Implements FMLiveSwitchStunAttribute.

◆ initWithIPAddress:port:

- (instancetype) initWithIPAddress: (NSString *)  ipAddress
port: (int)  port 

Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute class.

Parameters
ipAddressThe IP address.
portThe port.

◆ ipAddress

- (NSString*) ipAddress

Gets the IP address.

◆ mappedAddressAttributeWithIPAddress:port:

+ (FMLiveSwitchStunMappedAddressAttribute*) mappedAddressAttributeWithIPAddress: (NSString *)  ipAddress
port: (int)  port 

Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute class.

Parameters
ipAddressThe IP address.
portThe port.

◆ port

- (int) port

Gets the port.

◆ readValueFromWithBuffer:offset:

+ (FMLiveSwitchStunMappedAddressAttribute*) readValueFromWithBuffer: (FMLiveSwitchDataBuffer *)  buffer
offset: (int)  offset 

Initializes a new instance of the FMLiveSwitchStunMappedAddressAttribute class.

Parameters
bufferThe buffer.
offsetThe offset.

◆ setIPAddress:

- (void) setIPAddress: (NSString *)  value

Sets the IP address.

◆ setPort:

- (void) setPort: (int)  value

Sets the port.

◆ typeValue

- (int) typeValue

Gets the type value.

Implements FMLiveSwitchStunAttribute.

◆ writeValueToWithBuffer:offset:

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

Writes the value to.

Parameters
bufferThe buffer.
offsetThe offset.

Implements FMLiveSwitchStunAttribute.