org.ice4j.ice.harvest

Class SinglePortUdpHarvester.MyCandidate

java.lang.Object

org.ice4j.ice.Candidate<LocalCandidate>

org.ice4j.ice.LocalCandidate

org.ice4j.ice.HostCandidate

org.ice4j.ice.harvest.SinglePortUdpHarvester.MyCandidate

All Implemented Interfaces:

Comparable<LocalCandidate>

Enclosing class:

SinglePortUdpHarvester

private class SinglePortUdpHarvester.MyCandidate
extends HostCandidate

Implements a Candidate for the purposes of this SinglePortUdpHarvester.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<SocketAddress,IceSocketWrapper>	candidateSockets The collection of IceSocketWrappers that can potentially be used by the ice4j user to read/write from/to this candidate.
private boolean	freed The flag which indicates that this MyCandidate has been freed.
private Map<SocketAddress,DatagramSocket>	sockets The collection of DatagramSockets added to this candidate.
private String	ufrag The local username fragment associated with this 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

Modifier	Constructor and Description
private	MyCandidate(Component component, String ufrag) Initializes a new MyCandidate instance with the given Component and the given local username fragment.

Method Summary

Modifier and Type	Method and Description
private void	addSocket(DatagramSocket socket, InetSocketAddress remoteAddress) Adds a new Socket to this candidate, which is associated with a particular remote address.
void	free() Frees resources allocated by this candidate such as its DatagramSocket, for example.
protected IceSocketWrapper	getCandidateIceSocketWrapper(SocketAddress remoteAddress)

Methods inherited from class org.ice4j.ice.HostCandidate

createStunDatagramPacketFilter, getCandidateIceSocketWrapper

Methods inherited from class org.ice4j.ice.LocalCandidate

findRelatedCandidate, getDatagramSocket, getExtendedType, getIceSocketWrapper, getSocket, getStunSocket, getStunStack, getUfrag, isDefault, isSSL, setExtendedType, setSSL, setUfrag

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

ufrag

private final String ufrag

The local username fragment associated with this candidate.

freed

private boolean freed

The flag which indicates that this MyCandidate has been freed.

candidateSockets

private final Map<SocketAddress,IceSocketWrapper> candidateSockets

The collection of IceSocketWrappers that can potentially be used by the ice4j user to read/write from/to this candidate. The keys are the remote addresses for each socket.

There are wrappers over MultiplexedDatagramSockets over a corresponding socket in sockets.

sockets

private final Map<SocketAddress,DatagramSocket> sockets

The collection of DatagramSockets added to this candidate. The keys are the remote addresses for each socket.

These are the "raw" sockets, before any wrappers are added for the STUN stack or the user of ice4j.

Constructor Detail

MyCandidate

private MyCandidate(Component component,
                    String ufrag)

Initializes a new MyCandidate instance with the given Component and the given local username fragment.

Parameters:

component - the Component for which this candidate will serve.

ufrag - the local ICE username fragment for this candidate (and its Component and Agent).

Method Detail

free

public 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.

Closes all sockets in use by this LocalCandidate.

Overrides:

free in class LocalCandidate

addSocket

private void addSocket(DatagramSocket socket,
                       InetSocketAddress remoteAddress)
                throws IOException

Adds a new Socket to this candidate, which is associated with a particular remote address.

Parameters:

socket - the socket to add.

remoteAddress - the remote address for the socket.

Throws:

IOException

getCandidateIceSocketWrapper

protected IceSocketWrapper getCandidateIceSocketWrapper(SocketAddress remoteAddress)

Overrides:

getCandidateIceSocketWrapper in class LocalCandidate

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.