FMIceLinkStunMessage Class Reference

Inherits from	NSObject
Declared in	FMIceLinkStunMessage.h FMIceLinkStunMessage.m

`+ allocateMethod`

Gets the allocate [method](#//api/name/method).

+ (int)allocateMethod

Discussion

Gets the allocate [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`– attributes`

Gets the message attributes.

- (NSMutableArray *)attributes

Discussion

Gets the message attributes.

Declared In

FMIceLinkStunMessage.h

`+ bindingMethod`

Gets the binding [method](#//api/name/method).

+ (int)bindingMethod

Discussion

Gets the binding [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ channelBindMethod`

Gets the channel-bind [method](#//api/name/method).

+ (int)channelBindMethod

Discussion

Gets the channel-bind [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ connectionAttemptMethod`

Gets the connection-attempt [method](#//api/name/method).

+ (int)connectionAttemptMethod

Discussion

Gets the connection-attempt [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ connectionBindMethod`

Gets the connection-bind [method](#//api/name/method).

+ (int)connectionBindMethod

Discussion

Gets the connection-bind [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ connectMethod`

Gets the connect [method](#//api/name/method).

+ (int)connectMethod

Discussion

Gets the connect [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ createMessageWithMethod:messageType:transactionId:`

Creates a message.

+ (FMIceLinkStunMessage *)createMessageWithMethod:(int)method messageType:(FMIceLinkStunMessageType)messageType transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

`method`	The method.
`messageType`	Type of the message.
`transactionId`	The transaction ID. @return

Discussion

Creates a message.

Declared In

FMIceLinkStunMessage.h

`+ createPermissionMethod`

Gets the create-permission [method](#//api/name/method).

+ (int)createPermissionMethod

Discussion

Gets the create-permission [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ dataMethod`

Gets the data [method](#//api/name/method).

+ (int)dataMethod

Discussion

Gets the data [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ generateTransactionId`

Generates a random transaction ID.

+ (FMIceLinkDataBuffer *)generateTransactionId

Discussion

Generates a random transaction ID.

Declared In

FMIceLinkStunMessage.h

`– getAlternateServer`

Gets the alternate-server attribute.

- (FMIceLinkStunAlternateServerAttribute *)getAlternateServer

Discussion

Gets the alternate-server attribute.

Declared In

FMIceLinkStunMessage.h

`– getChannelNumber`

Gets the channel-number attribute.

- (FMIceLinkStunTurnChannelNumberAttribute *)getChannelNumber

Discussion

Gets the channel-number attribute.

Declared In

FMIceLinkStunMessage.h

`– getConnectionId`

Gets the connection-id attribute.

- (FMIceLinkStunTurnConnectionIdAttribute *)getConnectionId

Discussion

Gets the connection-id attribute.

Declared In

FMIceLinkStunMessage.h

`– getData`

Gets the data attribute.

- (FMIceLinkStunTurnDataAttribute *)getData

Discussion

Gets the data attribute.

Declared In

FMIceLinkStunMessage.h

`– getDontFragment`

Gets the don't-fragment attribute.

- (FMIceLinkStunTurnDontFragmentAttribute *)getDontFragment

Discussion

Gets the don't-fragment attribute.

Declared In

FMIceLinkStunMessage.h

`– getErrorCode`

Gets the error-code attribute.

- (FMIceLinkStunErrorCodeAttribute *)getErrorCode

Discussion

Gets the error-code attribute.

Declared In

FMIceLinkStunMessage.h

`– getEvenPort`

Gets the even-port attribute.

- (FMIceLinkStunTurnEvenPortAttribute *)getEvenPort

Discussion

Gets the even-port attribute.

Declared In

FMIceLinkStunMessage.h

`– getFingerprint`

Gets the fingerprint attribute.

- (FMIceLinkStunFingerprintAttribute *)getFingerprint

Discussion

Gets the fingerprint attribute.

Declared In

FMIceLinkStunMessage.h

`– getIceControlled`

Gets the ICE-controlled attribute.

- (FMIceLinkStunIceControlledAttribute *)getIceControlled

Discussion

Gets the ICE-controlled attribute.

Declared In

FMIceLinkStunMessage.h

`– getIceControlling`

Gets the ICE-controlling attribute.

- (FMIceLinkStunIceControllingAttribute *)getIceControlling

Discussion

Gets the ICE-controlling attribute.

Declared In

FMIceLinkStunMessage.h

`– getLength`

Gets the length of the message.

@return

- (int)getLength

Discussion

Gets the length of the message.

@return

Declared In

FMIceLinkStunMessage.h

`– getLifetime`

Gets the lifetime attribute.

- (FMIceLinkStunTurnLifetimeAttribute *)getLifetime

Discussion

Gets the lifetime attribute.

Declared In

FMIceLinkStunMessage.h

`– getMappedAddress`

Gets the mapped-address attribute.

- (FMIceLinkStunMappedAddressAttribute *)getMappedAddress

Discussion

Gets the mapped-address attribute.

Declared In

FMIceLinkStunMessage.h

`– getMessageIntegrity`

Gets the message-integrity attribute.

- (FMIceLinkStunMessageIntegrityAttribute *)getMessageIntegrity

Discussion

Gets the message-integrity attribute.

Declared In

FMIceLinkStunMessage.h

`– getNonce`

Gets the nonce attribute.

- (FMIceLinkStunNonceAttribute *)getNonce

Discussion

Gets the nonce attribute.

Declared In

FMIceLinkStunMessage.h

`– getPayloadLength`

Gets the length of the pay[load](#//api/name/load).

@return

- (int)getPayloadLength

Discussion

Gets the length of the pay[load](#//api/name/load).

@return

Declared In

FMIceLinkStunMessage.h

`– getPriority`

Gets the priority attribute.

- (FMIceLinkStunIcePriorityAttribute *)getPriority

Discussion

Gets the priority attribute.

Declared In

FMIceLinkStunMessage.h

`– getRealm`

Gets the realm attribute.

- (FMIceLinkStunRealmAttribute *)getRealm

Discussion

Gets the realm attribute.

Declared In

FMIceLinkStunMessage.h

`– getRequestedAddressFamily`

Gets the requested-address-family attribute.

- (FMIceLinkStunTurnRequestedAddressFamilyAttribute *)getRequestedAddressFamily

Discussion

Gets the requested-address-family attribute.

Declared In

FMIceLinkStunMessage.h

`– getRequestedTransport`

Gets the requested-transport attribute.

- (FMIceLinkStunTurnRequestedTransportAttribute *)getRequestedTransport

Discussion

Gets the requested-transport attribute.

Declared In

FMIceLinkStunMessage.h

`– getReservationToken`

Gets the reservation-token attribute.

- (FMIceLinkStunTurnReservationTokenAttribute *)getReservationToken

Discussion

Gets the reservation-token attribute.

Declared In

FMIceLinkStunMessage.h

`– getSoftware`

Gets the software attribute.

- (FMIceLinkStunSoftwareAttribute *)getSoftware

Discussion

Gets the software attribute.

Declared In

FMIceLinkStunMessage.h

`– getTransactionTransmitCounter`

Gets the transaction-transmit-counter attribute.

- (FMIceLinkStunTransactionTransmitCounterAttribute *)getTransactionTransmitCounter

Discussion

Gets the transaction-transmit-counter attribute.

Declared In

FMIceLinkStunMessage.h

`– getUnknownAttributes`

Gets the unknown[attributes](#//api/name/attributes) attribute.

- (FMIceLinkStunUnknownAttributesAttribute *)getUnknownAttributes

Discussion

Gets the unknown[attributes](#//api/name/attributes) attribute.

Declared In

FMIceLinkStunMessage.h

`– getUseCandidate`

Gets the use-candidate attribute.

- (FMIceLinkStunIceUseCandidateAttribute *)getUseCandidate

Discussion

Gets the use-candidate attribute.

Declared In

FMIceLinkStunMessage.h

`– getUsername`

Gets the username attribute.

- (FMIceLinkStunUsernameAttribute *)getUsername

Discussion

Gets the username attribute.

Declared In

FMIceLinkStunMessage.h

`– getXorMappedAddress`

Gets the XOR-mapped-address attribute.

- (FMIceLinkStunXorMappedAddressAttribute *)getXorMappedAddress

Discussion

Gets the XOR-mapped-address attribute.

Declared In

FMIceLinkStunMessage.h

`– getXorPeerAddress`

Gets the XOR-peer-address attribute.

- (FMIceLinkStunTurnXorPeerAddressAttribute *)getXorPeerAddress

Discussion

Gets the XOR-peer-address attribute.

Declared In

FMIceLinkStunMessage.h

`– getXorRelayedAddress`

Gets the XOR-relayed-address attribute.

- (FMIceLinkStunTurnXorRelayedAddressAttribute *)getXorRelayedAddress

Discussion

Gets the XOR-relayed-address attribute.

Declared In

FMIceLinkStunMessage.h

`– initWithMessageType:transactionId:`

Initializes a new instance of the FMIceLinkStunMessage class.

- (instancetype)initWithMessageType:(FMIceLinkStunMessageType)messageType transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

`messageType`	The type of the message.
`transactionId`	The transaction ID.

Discussion

Initializes a new instance of the FMIceLinkStunMessage class.

Declared In

FMIceLinkStunMessage.h

`+ magicCookieBytes`

Gets the "magic cookie" bytes.

+ (NSMutableData *)magicCookieBytes

Discussion

Gets the "magic cookie" bytes.

Declared In

FMIceLinkStunMessage.h

`+ magicCookieValue`

Gets the "magic cookie" value.

+ (long long)magicCookieValue

Discussion

Gets the "magic cookie" value.

Declared In

FMIceLinkStunMessage.h

`– messageType`

Gets the message type.

- (FMIceLinkStunMessageType)messageType

Discussion

Gets the message type.

Declared In

FMIceLinkStunMessage.h

`+ messageWithMessageType:transactionId:`

Initializes a new instance of the FMIceLinkStunMessage class.

+ (FMIceLinkStunMessage *)messageWithMessageType:(FMIceLinkStunMessageType)messageType transactionId:(FMIceLinkDataBuffer *)transactionId

Parameters

`messageType`	The type of the message.
`transactionId`	The transaction ID.

Discussion

Initializes a new instance of the FMIceLinkStunMessage class.

Declared In

FMIceLinkStunMessage.h

`– method`

Gets the method.

- (int)method

Discussion

Gets the method.

Declared In

FMIceLinkStunMessage.h

`+ readFromWithBuffer:`

Reads a FMIceLinkStunMessage instance from a buffer.

+ (FMIceLinkStunMessage *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The buffer. @return

Discussion

Reads a FMIceLinkStunMessage instance from a buffer.

Declared In

FMIceLinkStunMessage.h

`+ readFromWithBuffer:offset:`

Reads a FMIceLinkStunMessage instance from a buffer.

+ (FMIceLinkStunMessage *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset

Parameters

`buffer`	The buffer.
`offset`	The offset. @return

Discussion

Reads a FMIceLinkStunMessage instance from a buffer.

Declared In

FMIceLinkStunMessage.h

`+ readFromWithBuffer:offset:length:`

Reads an FMIceLinkStunMessage instance from a buffer.

+ (FMIceLinkStunMessage *)readFromWithBuffer:(FMIceLinkDataBuffer *)buffer offset:(int)offset length:(int *)length

Parameters

`buffer`	The buffer.
`offset`	The offset.
`length`	The length of the parsed segment. @return

Discussion

Reads an FMIceLinkStunMessage instance from a buffer.

Declared In

FMIceLinkStunMessage.h

`+ refreshMethod`

Gets the refresh [method](#//api/name/method).

+ (int)refreshMethod

Discussion

Gets the refresh [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`+ sendMethod`

Gets the send [method](#//api/name/method).

+ (int)sendMethod

Discussion

Gets the send [method](#//api/name/method).

Declared In

FMIceLinkStunMessage.h

`– setAlternateServerWithAttribute:`

Set the alternate-server attribute.

- (void)setAlternateServerWithAttribute:(FMIceLinkStunAlternateServerAttribute *)attribute

Parameters

`attribute`	The alternate-server attribute.

Discussion

Set the alternate-server attribute.

Declared In

FMIceLinkStunMessage.h

`– setChannelNumberWithAttribute:`

Sets the channel-number attribute.

- (void)setChannelNumberWithAttribute:(FMIceLinkStunTurnChannelNumberAttribute *)attribute

Parameters

`attribute`	The channel-number attribute.

Discussion

Sets the channel-number attribute.

Declared In

FMIceLinkStunMessage.h

`– setConnectionIdWithAttribute:`

Sets the connection-id attribute.

- (void)setConnectionIdWithAttribute:(FMIceLinkStunTurnConnectionIdAttribute *)attribute

Parameters

`attribute`	The connection-id attribute.

Discussion

Sets the connection-id attribute.

Declared In

FMIceLinkStunMessage.h

`– setDataWithAttribute:`

Sets the data attribute.

- (void)setDataWithAttribute:(FMIceLinkStunTurnDataAttribute *)attribute

Parameters

`attribute`	The data attribute.

Discussion

Sets the data attribute.

Declared In

FMIceLinkStunMessage.h

`– setDontFragmentWithAttribute:`

Sets the don't-fragment attribute.

- (void)setDontFragmentWithAttribute:(FMIceLinkStunTurnDontFragmentAttribute *)attribute

Parameters

`attribute`	The don’t-fragment attribute.

Discussion

Sets the don't-fragment attribute.

Declared In

FMIceLinkStunMessage.h

`– setErrorCodeWithAttribute:`

Set the error-code attribute.

- (void)setErrorCodeWithAttribute:(FMIceLinkStunErrorCodeAttribute *)attribute

Parameters

`attribute`	The error-code attribute.

Discussion

Set the error-code attribute.

Declared In

FMIceLinkStunMessage.h

`– setEvenPortWithAttribute:`

Sets the even-port attribute.

- (void)setEvenPortWithAttribute:(FMIceLinkStunTurnEvenPortAttribute *)attribute

Parameters

`attribute`	The even-port attribute.

Discussion

Sets the even-port attribute.

Declared In

FMIceLinkStunMessage.h

`– setFingerprintWithAttribute:`

Set the fingerprint attribute.

- (void)setFingerprintWithAttribute:(FMIceLinkStunFingerprintAttribute *)attribute

Parameters

`attribute`	The fingerprint attribute.

Discussion

Set the fingerprint attribute.

Declared In

FMIceLinkStunMessage.h

`– setIceControlledWithAttribute:`

Sets the ICE-controlled attribute.

- (void)setIceControlledWithAttribute:(FMIceLinkStunIceControlledAttribute *)attribute

Parameters

`attribute`	The ICE-controlled attribute.

Discussion

Sets the ICE-controlled attribute.

Declared In

FMIceLinkStunMessage.h

`– setIceControllingWithAttribute:`

Sets the ICE-controlling attribute.

- (void)setIceControllingWithAttribute:(FMIceLinkStunIceControllingAttribute *)attribute

Parameters

`attribute`	The ICE-controlling attribute.

Discussion

Sets the ICE-controlling attribute.

Declared In

FMIceLinkStunMessage.h

`– setLifetimeWithAttribute:`

Sets the lifetime attribute.

- (void)setLifetimeWithAttribute:(FMIceLinkStunTurnLifetimeAttribute *)attribute

Parameters

`attribute`	The lifetime attribute.

Discussion

Sets the lifetime attribute.

Declared In

FMIceLinkStunMessage.h

`– setMappedAddressWithAttribute:`

Set the mapped-address attribute.

- (void)setMappedAddressWithAttribute:(FMIceLinkStunMappedAddressAttribute *)attribute

Parameters

`attribute`	The mapped-address attribute.

Discussion

Set the mapped-address attribute.

Declared In

FMIceLinkStunMessage.h

`– setMessageIntegrityWithAttribute:`

Set the message-integrity attribute.

- (void)setMessageIntegrityWithAttribute:(FMIceLinkStunMessageIntegrityAttribute *)attribute

Parameters

`attribute`	The message-integrity attribute.

Discussion

Set the message-integrity attribute.

Declared In

FMIceLinkStunMessage.h

`– setNonceWithAttribute:`

Set the nonce attribute.

- (void)setNonceWithAttribute:(FMIceLinkStunNonceAttribute *)attribute

Parameters

`attribute`	The nonce attribute.

Discussion

Set the nonce attribute.

Declared In

FMIceLinkStunMessage.h

`– setPriorityWithAttribute:`

Sets the priority attribute.

- (void)setPriorityWithAttribute:(FMIceLinkStunIcePriorityAttribute *)attribute

Parameters

`attribute`	The priority attribute.

Discussion

Sets the priority attribute.

Declared In

FMIceLinkStunMessage.h

`– setRealmWithAttribute:`

Set the realm attribute.

- (void)setRealmWithAttribute:(FMIceLinkStunRealmAttribute *)attribute

Parameters

`attribute`	The realm attribute.

Discussion

Set the realm attribute.

Declared In

FMIceLinkStunMessage.h

`– setRequestedAddressFamilyWithAttribute:`

Sets the requested-address-family attribute.

- (void)setRequestedAddressFamilyWithAttribute:(FMIceLinkStunTurnRequestedAddressFamilyAttribute *)attribute

Parameters

`attribute`	The requested-address-family attribute.

Discussion

Sets the requested-address-family attribute.

Declared In

FMIceLinkStunMessage.h

`– setRequestedTransportWithAttribute:`

Sets the requested-transport attribute.

- (void)setRequestedTransportWithAttribute:(FMIceLinkStunTurnRequestedTransportAttribute *)attribute

Parameters

`attribute`	The requested-transport attribute.

Discussion

Sets the requested-transport attribute.

Declared In

FMIceLinkStunMessage.h

`– setReservationTokenWithAttribute:`

Sets the reservation-token attribute.

- (void)setReservationTokenWithAttribute:(FMIceLinkStunTurnReservationTokenAttribute *)attribute

Parameters

`attribute`	The reservation-token attribute.

Discussion

Sets the reservation-token attribute.

Declared In

FMIceLinkStunMessage.h

`– setSoftwareWithAttribute:`

Set the software attribute.

- (void)setSoftwareWithAttribute:(FMIceLinkStunSoftwareAttribute *)attribute

Parameters

`attribute`	The software attribute.

Discussion

Set the software attribute.

Declared In

FMIceLinkStunMessage.h

`– setTransactionTransmitCounterWithAttribute:`

Set the transaction-transmit-counter attribute.

- (void)setTransactionTransmitCounterWithAttribute:(FMIceLinkStunTransactionTransmitCounterAttribute *)attribute

Parameters

`attribute`	The transaction-transmit-counter attribute.

Discussion

Set the transaction-transmit-counter attribute.

Declared In

FMIceLinkStunMessage.h

`– setUnknownAttributesWithAttribute:`

Set the unknown[attributes](#//api/name/attributes) attribute.

- (void)setUnknownAttributesWithAttribute:(FMIceLinkStunUnknownAttributesAttribute *)attribute

Parameters

`attribute`	The unknownattributes attribute.

Discussion

Set the unknown[attributes](#//api/name/attributes) attribute.

Declared In

FMIceLinkStunMessage.h

`– setUseCandidateWithAttribute:`

Sets the use-candidate attribute.

- (void)setUseCandidateWithAttribute:(FMIceLinkStunIceUseCandidateAttribute *)attribute

Parameters

`attribute`	The use-candidate attribute.

Discussion

Sets the use-candidate attribute.

Declared In

FMIceLinkStunMessage.h

`– setUsernameWithAttribute:`

Set the username attribute.

- (void)setUsernameWithAttribute:(FMIceLinkStunUsernameAttribute *)attribute

Parameters

`attribute`	The username attribute.

Discussion

Set the username attribute.

Declared In

FMIceLinkStunMessage.h

`– setXorMappedAddressWithAttribute:`

Set the XOR-mapped-address attribute.

- (void)setXorMappedAddressWithAttribute:(FMIceLinkStunXorMappedAddressAttribute *)attribute

Parameters

`attribute`	The XOR-mapped-address attribute.

Discussion

Set the XOR-mapped-address attribute.

Declared In

FMIceLinkStunMessage.h

`– setXorPeerAddressWithAttribute:`

Sets the XOR-peer-address attribute.

- (void)setXorPeerAddressWithAttribute:(FMIceLinkStunTurnXorPeerAddressAttribute *)attribute

Parameters

`attribute`	The XOR-peer-address attribute.

Discussion

Sets the XOR-peer-address attribute.

Declared In

FMIceLinkStunMessage.h

`– setXorRelayedAddressWithAttribute:`

Sets the XOR-relayed-address attribute.

- (void)setXorRelayedAddressWithAttribute:(FMIceLinkStunTurnXorRelayedAddressAttribute *)attribute

Parameters

`attribute`	The XOR-relayed-address attribute.

Discussion

Sets the XOR-relayed-address attribute.

Declared In

FMIceLinkStunMessage.h

`– transactionId`

Gets the transaction ID.

- (FMIceLinkDataBuffer *)transactionId

Discussion

Gets the transaction ID.