Jerboa v0.2.0 API Reference
Modules
STUN/TURN encoder, decoder and client library
STUN client process
Encode and decode the STUN wire format
STUN protocol attributes
CHANNEL-NUMBER attribute as defined in TURN RFC
DATA attribute as defined in TURN RFC
DONT-FRAGMENT attribute as defined in TURN RFC
ERROR-CODE attribute as defined in STUN RFC
EVEN-PORT attribute as defined in TURN RFC
LIFETIME attribute as defined in TURN RFC
NONCE attribute as defined in STUN RFC
REALM attribute as defined in STUN RFC
REQUESTED-TRANSPORT attribute as defined in the TURN RFC
RESERVATION-TOKEN attribute as defined in TURN RFC
USERNAME attribute as defined in STUN RFC
XOR Mapped Address attribute as defined in the STUN RFC
XOR-PEER-ADDRESS attribute as defined in the TURN RFC
XOR-RELAYED-ADDRESS attribute as defined in the TURN RFC
The STUN message classes
The STUN message methods
Data structure representing STUN message parameters
Exceptions
Error indicating that binary representation of attribute isn’t compliant with STUN RFC
Error indicating STUN message with body shorter than that declared in header
Error indicating that the first two bits of a CHANNEL-NUMBER value do not match the required 0b01 value
Error indicating that the STUN message contained a comprehension-required attribute unknown to Jerboa
Error indicating that DONT-FRAGMENT found in STUN message has some value associated with it
Error indicating invalid format of ERROR-CODE attribute
Error indicating that ERROR-CODE attribute’s value is too short
Error indicating that EVEN-PORT attributes found in STUN message has invalid format
Error indicating wrong value encoded in first two bits of STUN message
Error indicating STUN message with header of invalid length
Error indicating that the last two bits of the STUN message length field are not zeroes (clear)
Error indicating that LIFETIME attribute’s value has invalid length
Error indicating that the message does not encode the magic cookie value
Error indicating badly encoded MESSAGE-INTEGRITY attribute found in STUN message
Error indicating that NONCE attribute’s value has invalid length
Error indicating that REALM attribute’s value has invalid length
Error indicating that REQUESTED-TRANSPORT attribute’s value has length different than 4 bytes
Error indication that RESERVATION-TOKEN attribute’s value has invalid (different than 8 bytes) length
Error indicating that the STUN message method is unknown to Jerboa
Error indicating that USERNAME attribute’s value has invalid length
Error indicating that the IP address family and IP address length of the XOR-MAPPED-ADDRESS, XOR-PEER-ADDRESS or XOR-RELAYED-ADDRESS attributes don’t make sense
Error indicating that the IP address family encoded in the XOR-MAPPED-ADDRESS, XOR-PEER-ADDRESS or XOR-RELAYED-ADDRESS attribute’s value is invalid
Error indicating that the XOR-MAPPED-ADDRESS, XOR-PEER-ADDRESS or XOR-RELAYED-ADDRESS attribute has invalid length