net.java.sip.communicator.impl.protocol.jabber.extensions.jingle
Enum CandidateType

java.lang.Object
  java.lang.Enum<CandidateType>
      net.java.sip.communicator.impl.protocol.jabber.extensions.jingle.CandidateType

All Implemented Interfaces:

Serializable, Comparable<CandidateType>

public enum CandidateType
extends Enum<CandidateType>

An enumeration containing allowed types for CandidatePacketExtensions.

Author:

Emil Ivov

Enum Constant Summary

host
Indicates that a candidate is a Host Candidate:
A candidate obtained by binding to a specific port from an IP address on the host.

local
Old name for Host Candidate used by Google Talk.

prflx
Indicates that a candidate is a Peer Reflexive Candidate:
A candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a STUN Binding request through the NAT to its peer.

relay
Indicates that a candidate is a Relayed Candidate:
A candidate obtained by sending a TURN Allocate request from a host candidate to a TURN server.

srflx
Indicates that a candidate is a Server Reflexive Candidate:
A candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a packet through the NAT to a server.

stun
Old name for Server Reflexive Candidate used by Google Talk.

Method Summary

static CandidateType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CandidateType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

host

public static final CandidateType host

Indicates that a candidate is a Host Candidate:
A candidate obtained by binding to a specific port from an IP address on the host. This includes IP addresses on physical interfaces and logical ones, such as ones obtained through Virtual Private Networks (VPNs) and Realm Specific IP.

prflx

public static final CandidateType prflx

Indicates that a candidate is a Peer Reflexive Candidate:
A candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a STUN Binding request through the NAT to its peer.

relay

public static final CandidateType relay

Indicates that a candidate is a Relayed Candidate:
A candidate obtained by sending a TURN Allocate request from a host candidate to a TURN server. The relayed candidate is resident on the TURN server, and the TURN server relays packets back towards the agent.

srflx

public static final CandidateType srflx

Indicates that a candidate is a Server Reflexive Candidate:
A candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a packet through the NAT to a server. Server reflexive candidates can be learned by STUN servers using the Binding request, or TURN servers, which provides both a relayed and server reflexive candidate.

stun

public static final CandidateType stun

Old name for Server Reflexive Candidate used by Google Talk.

local

public static final CandidateType local

Old name for Host Candidate used by Google Talk.

Method Detail

values

public static CandidateType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CandidateType c : CandidateType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CandidateType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null