 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
The SOFTWARE attribute contains a textual description of the software being used by the agent sending the message. 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 FMLiveSwitchStunSoftwareAttribute class. More... | |
| (void) | - setValue: |
| Sets the textual description of the software being used by the agent sending the message. More... | |
| (int) | - typeValue |
| Gets the type value. More... | |
| (NSString *) | - value |
| Gets the textual description of the software being used by the agent sending the message. 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 | |
| (FMLiveSwitchStunSoftwareAttribute *) | + readValueFromWithBuffer:offset:length: |
| Initializes a new instance of the FMLiveSwitchStunSoftwareAttribute class. More... | |
| (FMLiveSwitchStunSoftwareAttribute *) | + softwareAttribute: |
| Initializes a new instance of the FMLiveSwitchStunSoftwareAttribute 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... | |
The SOFTWARE attribute contains a textual description of the software being used by the agent sending the message.
It is used by clients and servers. Its value SHOULD include manufacturer and version number. The attribute has no impact on operation of the protocol, and serves only as a tool for diagnostic and debugging purposes. The value of SOFTWARE is variable length. It MUST be a UTF-8 [RFC3629] encoded sequence of less than 128 characters (which can be as long as 763 bytes).
| - (NSString*) description |
Returns a string that represents this instance.
| - (int) getValueLength |
Gets the length of the attribute value.
Implements FMLiveSwitchStunAttribute.
| - (instancetype) initWithValue: | (NSString *) | value |
Initializes a new instance of the FMLiveSwitchStunSoftwareAttribute class.
| value | The textual description of the software being used by the agent sending the message. |
| + (FMLiveSwitchStunSoftwareAttribute*) readValueFromWithBuffer: | (FMLiveSwitchDataBuffer *) | buffer | |
| offset: | (int) | offset | |
| length: | (int) | length | |
Initializes a new instance of the FMLiveSwitchStunSoftwareAttribute class.
| buffer | The buffer. |
| offset | The offset. |
| length | The length. |
| - (void) setValue: | (NSString *) | value |
Sets the textual description of the software being used by the agent sending the message.
| + (FMLiveSwitchStunSoftwareAttribute*) softwareAttribute: | (NSString *) | value |
Initializes a new instance of the FMLiveSwitchStunSoftwareAttribute class.
| value | The textual description of the software being used by the agent sending the message. |
| - (int) typeValue |
Gets the type value.
Implements FMLiveSwitchStunAttribute.
| - (NSString*) value |
Gets the textual description of the software being used by the agent sending the message.
| - (void) writeValueToWithBuffer: | (FMLiveSwitchDataBuffer *) | buffer | |
| offset: | (int) | offset | |
Writes the attribute value to a data buffer.
| buffer | The buffer. |
| offset | The offset. |
Implements FMLiveSwitchStunAttribute.