org.restcomm.media.ice

Class IceCandidate

java.lang.Object

java.net.SocketAddress

java.net.InetSocketAddress

org.restcomm.media.network.deprecated.TransportAddress

org.restcomm.media.ice.IceCandidate

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IceCandidate>

Direct Known Subclasses:

HostCandidate, ServerReflexiveCandidate

public class IceCandidate
extends TransportAddress
implements Comparable<IceCandidate>, Cloneable

A Candidate is a transport address that is a potential point of contact for receipt of media.
Candidates also have properties -- their type (server reflexive, relayed or host), priority, foundation, and base.

Author:

Henrique Rosa

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.restcomm.media.network.deprecated.TransportAddress

TransportAddress.TransportProtocol

Field Summary

Fields

Modifier and Type	Field and Description
protected IceCandidate	base The base of a server reflexive candidate is the host candidate from which it was derived. A host candidate is also said to have a base, equal to that candidate itself.
static int	IP4_PRECEDENCE

Fields inherited from class org.restcomm.media.network.deprecated.TransportAddress

protocol, virtual

Constructor Summary

Constructors

Modifier	Constructor and Description
	IceCandidate(IceComponent component, InetAddress address, int port, CandidateType type)
protected	IceCandidate(IceComponent component, String hostname, int port, CandidateType type)

Method Summary

Methods

Modifier and Type	Method and Description
IceCandidate	clone()
int	compareTo(IceCandidate o)
int	getAddressPrecedence()
IceCandidate	getBase()
short	getComponentId()
String	getFoundation()
long	getPriority()
CandidateType	getType()
void	setFoundation(String foundation)
void	setPriority(long priority)

Methods inherited from class org.restcomm.media.network.deprecated.TransportAddress

getAddressBytes, getProtocol, isIPv4, isIPv6, isVirtual, setVirtual

Methods inherited from class java.net.InetSocketAddress

createUnresolved, equals, getAddress, getHostName, getHostString, getPort, hashCode, isUnresolved, toString

Methods inherited from class java.lang.Object

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

Field Detail

IP4_PRECEDENCE

public static final int IP4_PRECEDENCE

See Also:

Constant Field Values

base

protected IceCandidate base

The base of a server reflexive candidate is the host candidate from which it was derived.
A host candidate is also said to have a base, equal to that candidate itself. Similarly, the base of a relayed candidate is that candidate itself.

Constructor Detail

IceCandidate

public IceCandidate(IceComponent component,
            InetAddress address,
            int port,
            CandidateType type)

IceCandidate

protected IceCandidate(IceComponent component,
            String hostname,
            int port,
            CandidateType type)

Method Detail

getType

public CandidateType getType()

getFoundation

public String getFoundation()

setFoundation

public void setFoundation(String foundation)

getAddressPrecedence

public int getAddressPrecedence()

getPriority

public long getPriority()

setPriority

public void setPriority(long priority)

getBase

public IceCandidate getBase()

compareTo

public int compareTo(IceCandidate o)

Specified by:

compareTo in interface Comparable<IceCandidate>

clone

public IceCandidate clone()
                   throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getComponentId

public short getComponentId()