public class CandidatePacketExtension extends AbstractPacketExtension implements java.lang.Comparable<CandidatePacketExtension>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_ATTR_NAME
The name of the "component" element.
|
static java.lang.String |
ELEMENT_NAME
The name of the "candidate" element.
|
static java.lang.String |
FOUNDATION_ATTR_NAME
The name of the "foundation" element.
|
static java.lang.String |
GENERATION_ATTR_NAME
The name of the "generation" element.
|
static java.lang.String |
ID_ATTR_NAME
The name of the "id" element.
|
static java.lang.String |
IP_ATTR_NAME
The name of the "ip" element.
|
static java.lang.String |
NETWORK_ATTR_NAME
The name of the "network" element.
|
static java.lang.String |
PORT_ATTR_NAME
The name of the "port" element.
|
static java.lang.String |
PRIORITY_ATTR_NAME
The name of the "priority" element.
|
static java.lang.String |
PROTOCOL_ATTR_NAME
The name of the "protocol" element.
|
static java.lang.String |
REL_ADDR_ATTR_NAME
The name of the "rel-addr" element.
|
static java.lang.String |
REL_PORT_ATTR_NAME
The name of the "rel-port" element.
|
static int |
RTCP_COMPONENT_ID
The "component" ID for RTCP components.
|
static int |
RTP_COMPONENT_ID
The "component" ID for RTP components.
|
static java.lang.String |
TCPTYPE_ATTR_NAME
The name of the "tcptype" element.
|
static java.lang.String |
TYPE_ATTR_NAME
The name of the "type" element.
|
attributes
Modifier | Constructor and Description |
---|---|
|
CandidatePacketExtension()
Creates a new
CandidatePacketExtension |
protected |
CandidatePacketExtension(java.lang.String elementName)
Creates a new
CandidatePacketExtension with the specified
elementName so that this class would be usable as a
RemoteCandidatePacketExtension parent. |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(CandidatePacketExtension candidatePacketExtension)
Compares this instance with another CandidatePacketExtension by
preference of type: host < local < prflx < srflx < stun < relay.
|
int |
getComponent()
Returns a component ID as defined in ICE-CORE.
|
java.lang.String |
getFoundation()
Returns the candidate foundation as defined in ICE-CORE.
|
int |
getGeneration()
Returns this candidate's generation.
|
java.lang.String |
getID()
Returns this candidates's unique identifier String.
|
java.lang.String |
getIP()
Returns this candidate's Internet Protocol (IP) address; this can be
either an IPv4 address or an IPv6 address.
|
int |
getNetwork()
Returns the network index indicating the interface that the candidate
belongs to.
|
int |
getPort()
Returns this candidate's port number.
|
int |
getPriority()
This candidate's priority as defined in ICE's RFC 5245
|
java.lang.String |
getProtocol()
Sets this candidate's transport protocol.
|
java.lang.String |
getRelAddr()
Returns this candidate's related address as described by ICE's RFC 5245.
|
int |
getRelPort()
Returns this candidate's related port as described by ICE's RFC 5245.
|
org.ice4j.ice.CandidateTcpType |
getTcpType()
Gets the TCP type for this CandidatePacketExtension.
|
CandidateType |
getType()
Returns a Candidate Type as defined in ICE-CORE.
|
void |
setComponent(int component)
Sets a component ID as defined in ICE-CORE.
|
void |
setFoundation(java.lang.String foundation)
Sets the candidate foundation as defined in ICE-CORE.
|
void |
setGeneration(int generation)
Sets this candidate's generation index.
|
void |
setID(java.lang.String id)
Sets this candidates's unique identifier String.
|
void |
setIP(java.lang.String ip)
Sets this candidate's Internet Protocol (IP) address; this can be either
an IPv4 address or an IPv6 address.
|
void |
setNetwork(int network)
The network index indicating the interface that the candidate belongs to.
|
void |
setPort(int port)
Sets this candidate's port number.
|
void |
setPriority(long priority)
This candidate's priority as defined in ICE's RFC 5245
|
void |
setProtocol(java.lang.String protocol)
Sets this candidate's transport protocol.
|
void |
setRelAddr(java.lang.String relAddr)
Sets this candidate's related address as described by ICE's RFC 5245.
|
void |
setRelPort(int relPort)
Sets this candidate's related port as described by ICE's RFC 5245.
|
void |
setTcpType(org.ice4j.ice.CandidateTcpType tcpType)
Sets the TCP type for this CandidatePacketExtension.
|
void |
setType(CandidateType type)
Sets a Candidate Type as defined in ICE-CORE.
|
addChildExtension, addPacket, clone, getAttribute, getAttributeAsInt, getAttributeAsInt, getAttributeAsString, getAttributeAsURI, getAttributeNames, getChildExtensions, getChildExtensionsOfType, getElementName, getFirstChildOfType, getNamespace, getPackets, getText, removeAttribute, setAttribute, setNamespace, setText, toXML
public static final java.lang.String ELEMENT_NAME
public static final java.lang.String COMPONENT_ATTR_NAME
public static final int RTP_COMPONENT_ID
public static final int RTCP_COMPONENT_ID
public static final java.lang.String FOUNDATION_ATTR_NAME
public static final java.lang.String GENERATION_ATTR_NAME
public static final java.lang.String ID_ATTR_NAME
public static final java.lang.String IP_ATTR_NAME
public static final java.lang.String NETWORK_ATTR_NAME
public static final java.lang.String PORT_ATTR_NAME
public static final java.lang.String PRIORITY_ATTR_NAME
public static final java.lang.String PROTOCOL_ATTR_NAME
public static final java.lang.String REL_ADDR_ATTR_NAME
public static final java.lang.String REL_PORT_ATTR_NAME
public static final java.lang.String TYPE_ATTR_NAME
public static final java.lang.String TCPTYPE_ATTR_NAME
public CandidatePacketExtension()
CandidatePacketExtension
protected CandidatePacketExtension(java.lang.String elementName)
CandidatePacketExtension
with the specified
elementName so that this class would be usable as a
RemoteCandidatePacketExtension parent.elementName
- the element name that this instance should be using.public void setComponent(int component)
component
- a component ID as defined in ICE-CORE.public int getComponent()
public void setFoundation(java.lang.String foundation)
foundation
- the candidate foundation as defined in ICE-CORE.public java.lang.String getFoundation()
public void setGeneration(int generation)
generation
- this candidate's generation index.public int getGeneration()
public void setID(java.lang.String id)
id
- this candidates's unique identifier Stringpublic java.lang.String getID()
public void setIP(java.lang.String ip)
ip
- this candidate's IPv4 or IPv6 address.public java.lang.String getIP()
public void setNetwork(int network)
network
- the network index indicating the interface that the
candidate belongs to.public int getNetwork()
public void setPort(int port)
port
- this candidate's port number.public int getPort()
public void setPriority(long priority)
priority
- this candidate's prioritypublic int getPriority()
public void setProtocol(java.lang.String protocol)
protocol
- this candidate's transport protocol.public java.lang.String getProtocol()
public void setRelAddr(java.lang.String relAddr)
relAddr
- this candidate's related address as described by ICE's
RFC 5245.public java.lang.String getRelAddr()
public void setRelPort(int relPort)
relPort
- this candidate's related port as described by ICE's
RFC 5245.public int getRelPort()
public void setType(CandidateType type)
CandidateType
enum.type
- this candidates' type as per ICE's RFC 5245.public CandidateType getType()
CandidateType
enum.public int compareTo(CandidatePacketExtension candidatePacketExtension)
compareTo
in interface java.lang.Comparable<CandidatePacketExtension>
public org.ice4j.ice.CandidateTcpType getTcpType()
public void setTcpType(org.ice4j.ice.CandidateTcpType tcpType)
tcpType
-
Jitsi, the OpenSource Java VoIP and Instant Messaging client.
Distributable under Apache license.