public class ICECandidate extends TransportCandidate implements java.lang.Comparable<ICECandidate>
Modifier and Type | Class and Description |
---|---|
static class |
ICECandidate.Type |
TransportCandidate.CandidateEcho, TransportCandidate.Channel, TransportCandidate.Fixed, TransportCandidate.Protocol
password
Constructor and Description |
---|
ICECandidate() |
ICECandidate(java.lang.String ip,
int generation,
int network,
java.lang.String password,
int port,
java.lang.String username,
int preference,
ICECandidate.Type type)
Constructor with the basic elements of a transport definition.
|
Modifier and Type | Method and Description |
---|---|
void |
check(java.util.List<TransportCandidate> localCandidates)
Check if a transport candidate is usable.
|
int |
compareTo(ICECandidate arg)
Compare the to other Transport candidate.
|
boolean |
equals(java.lang.Object obj) |
TransportCandidate.Channel |
getChannel()
Get the channel.
|
java.lang.String |
getId()
Get the ID.
|
int |
getNetwork()
Get the network interface used for this connection.
|
int |
getPreference()
Get the preference number for this transportElement.
|
TransportCandidate.Protocol |
getProto()
Get the protocol used for the transmission.
|
ICECandidate.Type |
getType()
Get the Candidate Type.
|
java.lang.String |
getUsername()
Get the username for this transportElement in ICE.
|
int |
hashCode() |
boolean |
isNull()
Return true if the candidate is not valid.
|
void |
setChannel(TransportCandidate.Channel channel)
Set the channel for this transportElement.
|
void |
setId(java.lang.String id)
Set the ID.
|
void |
setNetwork(int network)
Set the interface for this connection.
|
void |
setPreference(int preference)
Set the preference order for this transportElement.
|
void |
setProto(TransportCandidate.Protocol proto)
Set the protocol for the transmission.
|
void |
setType(ICECandidate.Type type)
Set the Candidate Type.
|
void |
setUsername(java.lang.String username)
Set the username for this transportElement in ICE.
|
addCandidateEcho, addListener, getCandidateEcho, getConnection, getGeneration, getIp, getListenersList, getLocalIp, getName, getPassword, getPort, getSessionId, getSymmetric, removeCandidateEcho, setConnection, setGeneration, setIp, setLocalIp, setName, setPassword, setPort, setSessionId, setSymmetric
public ICECandidate()
public ICECandidate(java.lang.String ip, int generation, int network, java.lang.String password, int port, java.lang.String username, int preference, ICECandidate.Type type)
ip
- the IP address to use as a local addressgeneration
- used to keep track of the candidatesnetwork
- used for diagnostics (used when the machine has
several NICs)password
- user name, as it is used in ICEport
- the port at the candidate IP addressusername
- user name, as it is used in ICEpreference
- preference for this transportElement, as it is used
in ICEtype
- type as defined in ICE-12public java.lang.String getId()
public void setId(java.lang.String id)
id
- the id to setpublic TransportCandidate.Protocol getProto()
public void setProto(TransportCandidate.Protocol proto)
proto
- the protocol to usepublic int getNetwork()
public void setNetwork(int network)
network
- the interface numberpublic java.lang.String getUsername()
public TransportCandidate.Channel getChannel()
public void setChannel(TransportCandidate.Channel channel)
channel
- the new channelpublic void setUsername(java.lang.String username)
username
- the username used in ICEpublic int getPreference()
public void setPreference(int preference)
preference
- a number identifying the preference (as defined in
ICE)public ICECandidate.Type getType()
public void setType(ICECandidate.Type type)
type
- candidate type.public void check(java.util.List<TransportCandidate> localCandidates)
check
in class TransportCandidate
public boolean equals(java.lang.Object obj)
equals
in class TransportCandidate
public int hashCode()
hashCode
in class java.lang.Object
public boolean isNull()
TransportCandidate
isNull
in class TransportCandidate
public int compareTo(ICECandidate arg)
compareTo
in interface java.lang.Comparable<ICECandidate>
arg
- another Transport candidate