org.ice4j.ice.harvest

Class StunMappingCandidateHarvester

java.lang.Object

org.ice4j.ice.harvest.AbstractCandidateHarvester

org.ice4j.ice.harvest.MappingCandidateHarvester

org.ice4j.ice.harvest.StunMappingCandidateHarvester

All Implemented Interfaces:

CandidateHarvester

public class StunMappingCandidateHarvester
extends MappingCandidateHarvester

A MappingCandidateHarvester which uses a STUN servers to discover its public IP address.

Author:

Damian Minkov, Boris Grozev

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	logger The Logger used by the StunMappingCandidateHarvester class and its instances for logging output.
private TransportAddress	stunServerAddress The list of servers we will use to discover our public address.

Fields inherited from class org.ice4j.ice.harvest.MappingCandidateHarvester

face, mask

Constructor Summary

Constructors

Constructor and Description
StunMappingCandidateHarvester(TransportAddress localAddress, TransportAddress stunServerAddress) Initializes a new StunMappingCandidateHarvester instance with a given local address and a STUN server address.

Method Summary

Modifier and Type	Method and Description
void	discover() Attempts to discover the the public address (mask) via the STUN server.

Methods inherited from class org.ice4j.ice.harvest.MappingCandidateHarvester

getFace, getMask, harvest, toString

Methods inherited from class org.ice4j.ice.harvest.AbstractCandidateHarvester

getHarvestStatistics, isHostHarvester

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

private static final Logger logger

The Logger used by the StunMappingCandidateHarvester class and its instances for logging output.

stunServerAddress

private TransportAddress stunServerAddress

The list of servers we will use to discover our public address.

Constructor Detail

StunMappingCandidateHarvester

public StunMappingCandidateHarvester(TransportAddress localAddress,
                                     TransportAddress stunServerAddress)

Initializes a new StunMappingCandidateHarvester instance with a given local address and a STUN server address. Note that the actual discovery of the public address needs to be initiated to a separate call to discover().

Parameters:

localAddress - The local address.

stunServerAddress - The address of the STUN server.

Method Detail

discover

public void discover()

Attempts to discover the the public address (mask) via the STUN server. Note that this will block until we either receive a response from the STUN server, or a timeout occurs.