FMIceLinkStunAttribute Class Reference

Inherits from NSObject
Declared in FMIceLinkStunAttribute.h
FMIceLinkStunAttribute.m

Overview

A STUN attribute.

+ alternateServerType

Gets the ALTERNATE-SERVER type.
+ (int)alternateServerType

Discussion

Gets the ALTERNATE-SERVER type.

Declared In

FMIceLinkStunAttribute.h

+ channelNumberType

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

Discussion

Gets the CHANNEL-NUMBER type.

Declared In

FMIceLinkStunAttribute.h

+ connectionIdType

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

Discussion

Gets the CONNECTION-ID type.

Declared In

FMIceLinkStunAttribute.h

+ controlledType

Gets the CONTROLLED type.
+ (int)controlledType

Discussion

Gets the CONTROLLED type.

Declared In

FMIceLinkStunAttribute.h

+ controllingType

Gets the CONTROLLING type.
+ (int)controllingType

Discussion

Gets the CONTROLLING type.

Declared In

FMIceLinkStunAttribute.h

+ dataType

Gets the DATA type.
+ (int)dataType

Discussion

Gets the DATA type.

Declared In

FMIceLinkStunAttribute.h

+ dontFragmentType

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

Discussion

Gets the DONT-FRAGMENT type.

Declared In

FMIceLinkStunAttribute.h

+ errorCodeType

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

Discussion

Gets the ERROR-CODE type.

Declared In

FMIceLinkStunAttribute.h

+ evenPortType

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

Discussion

Gets the EVEN-PORT type.

Declared In

FMIceLinkStunAttribute.h

+ fingerprintType

Gets the FINGERPRINT type.
+ (int)fingerprintType

Discussion

Gets the FINGERPRINT type.

Declared In

FMIceLinkStunAttribute.h

– getLength

Gets the length of the attribute, including header and padding.

@return

- (int)getLength

Discussion

Gets the length of the attribute, including header and padding.

@return

Declared In

FMIceLinkStunAttribute.h

– getPaddingLengthWithValueLength:

Gets the length of the padding.

@return

- (int)getPaddingLengthWithValueLength:(int)valueLength

Discussion

Gets the length of the padding.

@return

Declared In

FMIceLinkStunAttribute.h

– getValueLength

Gets the length of the attribute value.

@return

- (int)getValueLength

Discussion

Gets the length of the attribute value.

@return

Declared In

FMIceLinkStunAttribute.h

+ lifetimeType

Gets the LIFETIME type.
+ (int)lifetimeType

Discussion

Gets the LIFETIME type.

Declared In

FMIceLinkStunAttribute.h

+ mappedAddressType

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

Discussion

Gets the MAPPED-ADDRESS type.

Declared In

FMIceLinkStunAttribute.h

+ messageIntegrityType

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

Discussion

Gets the MESSAGE-INTEGRITY type.

Declared In

FMIceLinkStunAttribute.h

+ nextLengthWithBuffer:offset:

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

Parameters

buffer

The buffer.
offset

The offset. @return

Discussion

Reads the length of the next attribute from a data buffer, including header and padding.

Declared In

FMIceLinkStunAttribute.h

+ nonceType

Gets the NONCE type.
+ (int)nonceType

Discussion

Gets the NONCE type.

Declared In

FMIceLinkStunAttribute.h

+ priorityType

Gets the PRIORITY type.
+ (int)priorityType

Discussion

Gets the PRIORITY type.

Declared In

FMIceLinkStunAttribute.h

+ readAddressTypeWithBuffer:offset:

Reads an address type.
+ (FMIceLinkAddressType)readAddressTypeWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Parameters

buffer

The buffer.
offset

The offset. @return

Discussion

Reads an address type.

Declared In

FMIceLinkStunAttribute.h

+ readFromWithBuffer:offset:offsetPlus:transactionId:messageBuffer:

Reads an FMIceLinkStunAttribute from a data buffer.
+ (FMIceLinkStunAttribute *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset offsetPlus:(int *)offsetPlus transactionId:(FMIceLinkDataBuffer *)transactionId messageBuffer:(FMIceLinkDataBuffer *)messageBuffer

Parameters

buffer

The buffer.
offset

The offset.
offsetPlus

The offset plus the attribute length.
transactionId

The STUN message transaction ID.
messageBuffer

The STUN message thus far as a byte array. @return

Discussion

Reads an FMIceLinkStunAttribute from a data buffer.

Declared In

FMIceLinkStunAttribute.h

+ readFromWithBuffer:offset:transactionId:messageBuffer:

Reads an FMIceLinkStunAttribute from a data buffer.
+ (FMIceLinkStunAttribute *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset transactionId:(FMIceLinkDataBuffer *)transactionId messageBuffer:(FMIceLinkDataBuffer *)messageBuffer

Parameters

buffer

The buffer.
offset

The offset.
transactionId

The STUN message transaction ID.
messageBuffer

The STUN message thus far as a byte array. @return

Discussion

Reads an FMIceLinkStunAttribute from a data buffer.

Declared In

FMIceLinkStunAttribute.h

+ readIPAddressWithBuffer:offset:addressType:

Reads an IP address.
+ (NSString *)readIPAddressWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset addressType:(FMIceLinkAddressType)addressType

Parameters

buffer

The buffer.
offset

The offset.
addressType

The address type. @return

Discussion

Reads an IP address.

Declared In

FMIceLinkStunAttribute.h

+ readPortWithBuffer:offset:

Reads a port.
+ (int)readPortWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Parameters

buffer

The buffer.
offset

The offset. @return

Discussion

Reads a port.

Declared In

FMIceLinkStunAttribute.h

+ readXorIPAddressWithBuffer:offset:addressType:transactionId:

Reads an XOR'd IP address.
+ (NSString *)readXorIPAddressWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset addressType:(FMIceLinkAddressType)addressType transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

buffer

The buffer.
offset

The offset.
addressType

The address type.
transactionId

The transaction identifier. @return

Discussion

Reads an XOR'd IP address.

Declared In

FMIceLinkStunAttribute.h

+ readXorPortWithBuffer:offset:transactionId:

Reads an XOR'd port.
+ (int)readXorPortWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

buffer

The buffer.
offset

The offset.
transactionId

The transaction identifier. @return

Discussion

Reads an XOR'd port.

Declared In

FMIceLinkStunAttribute.h

+ realmType

Gets the REALM type.
+ (int)realmType

Discussion

Gets the REALM type.

Declared In

FMIceLinkStunAttribute.h

+ requestedAddressFamilyType

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

Discussion

Gets the REQUESTED-ADDRESS-FAMILY type.

Declared In

FMIceLinkStunAttribute.h

+ requestedTransportType

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

Discussion

Gets the REQUESTED-TRANSPORT type.

Declared In

FMIceLinkStunAttribute.h

+ reservationTokenType

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

Discussion

Gets the RESERVATION-TOKEN type.

Declared In

FMIceLinkStunAttribute.h

+ softwareType

Gets the SOFTWARE type.
+ (int)softwareType

Discussion

Gets the SOFTWARE type.

Declared In

FMIceLinkStunAttribute.h

+ transactionTransmitCounterType

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

Discussion

Gets the comprehension-optional TRANSACTION_TRANSMIT_COUNTER type defined in RFC 7982.

Declared In

FMIceLinkStunAttribute.h

– typeValue

Gets the type value.
- (int)typeValue

Discussion

Gets the type value.

Declared In

FMIceLinkStunAttribute.h

+ unknownAttributesType

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

Discussion

Gets the UNKNOWN-ATTRIBUTES type.

Declared In

FMIceLinkStunAttribute.h

+ useCandidateType

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

Discussion

Gets the USE-CANDIDATE type.

Declared In

FMIceLinkStunAttribute.h

+ usernameType

Gets the USERNAME type.
+ (int)usernameType

Discussion

Gets the USERNAME type.

Declared In

FMIceLinkStunAttribute.h

+ writeAddressTypeWithBuffer:offset:addressType:

Writes an address type.
+ (void)writeAddressTypeWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset addressType:(FMIceLinkAddressType)addressType

Parameters

buffer

The buffer.
offset

The offset.
addressType

The address type.

Discussion

Writes an address type.

Declared In

FMIceLinkStunAttribute.h

– writeIPAddressWithBuffer:offset:addressType:ipAddress:

Writes an IP address.
- (void)writeIPAddressWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset addressType:(FMIceLinkAddressType)addressType ipAddress:(NSString *)ipAddress

Parameters

buffer

The buffer.
offset

The offset.
addressType

The address type.
ipAddress

The IP address.

Discussion

Writes an IP address.

Declared In

FMIceLinkStunAttribute.h

– writePortWithBuffer:offset:port:

Writes a port.
- (void)writePortWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset port:(int)port

Parameters

buffer

The buffer.
offset

The offset.
port

The port.

Discussion

Writes a port.

Declared In

FMIceLinkStunAttribute.h

– writeToWithBuffer:offset:

Writes the attribute to a data buffer.
- (void)writeToWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Parameters

buffer

The buffer.
offset

The offset.

Discussion

Writes the attribute to a data buffer.

Declared In

FMIceLinkStunAttribute.h

– writeToWithBuffer:offset:offsetPlus:

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

Parameters

buffer

The buffer.
offset

The offset.
offsetPlus

The offset plus the value length.

Discussion

Writes the attribute to a data buffer.

Declared In

FMIceLinkStunAttribute.h

– writeValueToWithBuffer:offset:

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

Parameters

buffer

The buffer.
offset

The offset.

Discussion

Writes the attribute value to a data buffer.

Declared In

FMIceLinkStunAttribute.h

– writeXorIPAddressWithBuffer:offset:addressType:ipAddress:transactionId:

Writes an XOR'd IP address.
- (void)writeXorIPAddressWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset addressType:(FMIceLinkAddressType)addressType ipAddress:(NSString *)ipAddress transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

buffer

The buffer.
offset

The offset.
addressType

The address type.
ipAddress

The IP address.
transactionId

The transaction identifier.

Discussion

Writes an XOR'd IP address.

Declared In

FMIceLinkStunAttribute.h

– writeXorPortWithBuffer:offset:port:transactionId:

Writes an XOR'd port.
- (void)writeXorPortWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset port:(int)port transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

buffer

The buffer.
offset

The offset.
port

The port.
transactionId

The transaction identifier.

Discussion

Writes an XOR'd port.

Declared In

FMIceLinkStunAttribute.h

+ xorMappedAddressType

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

Discussion

Gets the XOR-MAPPED-ADDRESS type.

Declared In

FMIceLinkStunAttribute.h

+ xorPeerAddressType

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

Discussion

Gets the XOR-PEER-ADDRESS type.

Declared In

FMIceLinkStunAttribute.h

+ xorRelayedAddressType

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

Discussion

Gets the XOR-RELAYED-ADDRESS type.

Declared In

FMIceLinkStunAttribute.h