org.ice4j.ice

Class LocalCandidate

java.lang.Object

org.ice4j.ice.Candidate<LocalCandidate>

org.ice4j.ice.LocalCandidate

All Implemented Interfaces:

Comparable<LocalCandidate>

Direct Known Subclasses:

GoogleRelayedCandidate, HostCandidate, PeerReflexiveCandidate, RelayedCandidate, ServerReflexiveCandidate, UPNPCandidate

public abstract class LocalCandidate
extends Candidate<LocalCandidate>

LocalCandidates are obtained by an agent for every stream component and are then included in outgoing offers or answers.

Author:

Emil Ivov, Lyubomir Marinov

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	classLogger The Logger used by the LocalCandidate class for logging output.
private CandidateExtendedType	extendedType The type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").
private boolean	isSSL Whether this LocalCandidate uses SSL.
private Logger	logger The Logger used by LocalCandidate instances.
private String	ufrag Ufrag for the local candidate.

Fields inherited from class org.ice4j.ice.Candidate

MAX_LOCAL_PREFERENCE, MAX_TYPE_PREFERENCE, MIN_LOCAL_PREFERENCE, MIN_TYPE_PREFERENCE, priority

Constructor Summary

Constructors

Constructor and Description
LocalCandidate(TransportAddress transportAddress, Component parentComponent, CandidateType type, CandidateExtendedType extendedType, LocalCandidate relatedCandidate) Creates a LocalCandidate instance for the specified transport address and properties.

Method Summary

Modifier and Type	Method and Description
protected StunDatagramPacketFilter	createStunDatagramPacketFilter(TransportAddress serverAddress) Creates a new StunDatagramPacketFilter which is to capture STUN messages and make them available to the DatagramSocket returned by getStunSocket(TransportAddress).
protected LocalCandidate	findRelatedCandidate(TransportAddress relatedAddress) Find the candidate corresponding to the address given in parameter.
protected void	free() Frees resources allocated by this candidate such as its DatagramSocket, for example.
protected abstract IceSocketWrapper	getCandidateIceSocketWrapper()
protected IceSocketWrapper	getCandidateIceSocketWrapper(SocketAddress remoteAddress)
DatagramSocket	getDatagramSocket() Deprecated. This should be used by the library only. Users of ice4j should use Component.getSocket() instead.
CandidateExtendedType	getExtendedType() Returns the type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").
protected IceSocketWrapper	getIceSocketWrapper()
Socket	getSocket() Deprecated. This should be used by the library only. Users of ice4j should use Component.getSocket() instead.
IceSocketWrapper	getStunSocket(TransportAddress serverAddress) Creates if necessary and returns a DatagramSocket that would capture all STUN packets arriving on this candidate's socket.
StunStack	getStunStack() Gets the StunStack associated with this Candidate.
String	getUfrag() Get the local ufrag.
boolean	isDefault() Determines whether this Candidate is the default one for its parent component.
boolean	isSSL() Gets the value of the 'ssl' flag.
void	setExtendedType(CandidateExtendedType extendedType) Sets the type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").
void	setSSL(boolean isSSL) Sets the value of the 'ssl' flag.
void	setUfrag(String ufrag) Set the local ufrag.

Methods inherited from class org.ice4j.ice.Candidate

canReach, compareTo, computeGTalkPriority, computeGTalkPriorityForType, computePriority, computePriorityForType, equals, getBase, getDefaultPreference, getFoundation, getHostAddress, getMappedAddress, getParentComponent, getPriority, getReflexiveAddress, getRelatedAddress, getRelatedCandidate, getRelayedAddress, getRelayServerAddress, getStunServerAddress, getTcpType, getTransport, getTransportAddress, getType, hashCode, isVirtual, setBase, setCandidateType, setFoundation, setMappedAddress, setRelayServerAddress, setStunServerAddress, setTcpType, setVirtual, toShortString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

classLogger

private static final Logger classLogger

The Logger used by the LocalCandidate class for logging output. Note that this shouldn't be used directly by instances of DefaultNominator, because it doesn't take into account the per-instance log level. Instances should use logger instead.

extendedType

private CandidateExtendedType extendedType

The type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

ufrag

private String ufrag

Ufrag for the local candidate.

isSSL

private boolean isSSL

Whether this LocalCandidate uses SSL.

logger

private Logger logger

The Logger used by LocalCandidate instances.

Constructor Detail

LocalCandidate

public LocalCandidate(TransportAddress transportAddress,
                      Component parentComponent,
                      CandidateType type,
                      CandidateExtendedType extendedType,
                      LocalCandidate relatedCandidate)

Creates a LocalCandidate instance for the specified transport address and properties.

Parameters:

transportAddress - the transport address that this candidate is encapsulating.

parentComponent - the Component that this candidate belongs to.

type - the CandidateType for this Candidate.

extendedType - The type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

relatedCandidate - the relatedCandidate: null for a host candidate, the base address (host candidate) for a reflexive candidate, the mapped address (the mapped address of the TURN allocate response) for a relayed candidate.

Method Detail

getDatagramSocket

@Deprecated
public DatagramSocket getDatagramSocket()

Deprecated. This should be used by the library only. Users of ice4j should use Component.getSocket() instead.

Gets the DatagramSocket associated with this Candidate.

Returns:

the DatagramSocket associated with this Candidate

getSocket

@Deprecated
public Socket getSocket()

Deprecated. This should be used by the library only. Users of ice4j should use Component.getSocket() instead.

Gets the Socket associated with this Candidate.

Returns:

the Socket associated with this Candidate

getIceSocketWrapper

protected IceSocketWrapper getIceSocketWrapper()

Returns:

the IceSocketWrapper instance of the Component which owns this LocalCandidate. Note that this IS NOT an instance specific to this LocalCandidate. See getCandidateIceSocketWrapper().

getCandidateIceSocketWrapper

protected abstract IceSocketWrapper getCandidateIceSocketWrapper()

Returns:

the IceSocketWrapper instance, if any, associated with this candidate. Note that this IS NOT the instance which should be used for reading and writing by the application, and SHOULD NOT be used from outside ice4j (even if a subclass exposes it as public). Also see getIceSocketWrapper().

getCandidateIceSocketWrapper

protected IceSocketWrapper getCandidateIceSocketWrapper(SocketAddress remoteAddress)

Parameters:

remoteAddress - the remote address for which to return an associated socket.

Returns:

the IceSocketWrapper instance for this candidate, associated with a particular remote address.

getStunSocket

public IceSocketWrapper getStunSocket(TransportAddress serverAddress)

Creates if necessary and returns a DatagramSocket that would capture all STUN packets arriving on this candidate's socket. If the serverAddress parameter is not null this socket would only intercept packets originating at this address.

Parameters:

serverAddress - the address of the source we'd like to receive packets from or null if we'd like to intercept all STUN packets.

Returns:

the DatagramSocket that this candidate uses when sending and receiving STUN packets, while harvesting STUN candidates or performing connectivity checks.

getStunStack

public StunStack getStunStack()

Gets the StunStack associated with this Candidate.

Returns:

the StunStack associated with this Candidate

createStunDatagramPacketFilter

protected StunDatagramPacketFilter createStunDatagramPacketFilter(TransportAddress serverAddress)

Creates a new StunDatagramPacketFilter which is to capture STUN messages and make them available to the DatagramSocket returned by getStunSocket(TransportAddress).

Parameters:

serverAddress - the address of the source we'd like to receive packets from or null if we'd like to intercept all STUN packets

Returns:

the StunDatagramPacketFilter which is to capture STUN messages and make them available to the DatagramSocket returned by getStunSocket(TransportAddress)

free

protected void free()

Frees resources allocated by this candidate such as its DatagramSocket, for example. The socket of this LocalCandidate is closed only if it is not the socket of the base of this LocalCandidate.

isDefault

public boolean isDefault()

Determines whether this Candidate is the default one for its parent component.

Specified by:

isDefault in class Candidate<LocalCandidate>

Returns:

true if this Candidate is the default for its parent component and false if it isn't or if it has no parent Component yet.

setUfrag

public void setUfrag(String ufrag)

Set the local ufrag.

Parameters:

ufrag - local ufrag

getUfrag

public String getUfrag()

Get the local ufrag.

Specified by:

getUfrag in class Candidate<LocalCandidate>

Returns:

local ufrag

getExtendedType

public CandidateExtendedType getExtendedType()

Returns the type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

Returns:

The type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

setExtendedType

public void setExtendedType(CandidateExtendedType extendedType)

Sets the type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

Parameters:

extendedType - The type of method used to discover this candidate ("host", "upnp", "stun peer reflexive", "stun server reflexive", "turn relayed", "google turn relayed", "google tcp turn relayed" or "jingle node").

findRelatedCandidate

protected LocalCandidate findRelatedCandidate(TransportAddress relatedAddress)

Find the candidate corresponding to the address given in parameter.

Specified by:

findRelatedCandidate in class Candidate<LocalCandidate>

Parameters:

relatedAddress - The related address: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.

Returns:

The related candidate corresponding to the address given in parameter: - null for a host candidate, - the base address (host candidate) for a reflexive candidate, - the mapped address (the mapped address of the TURN allocate response) for a relayed candidate. - null for a peer reflexive candidate : there is no way to know the related address.

isSSL

public boolean isSSL()

Gets the value of the 'ssl' flag.

Returns:

the value of the 'ssl' flag.

setSSL

public void setSSL(boolean isSSL)

Sets the value of the 'ssl' flag.

Parameters:

isSSL - the value to set.