Package 

Class HostCandidate

  • All Implemented Interfaces:
    java.lang.Comparable 
    
public class HostCandidate
extends LocalCandidate

    HostCandidates are obtained by binding to a specific port from an IP address on the host that is running us. This includes IP addresses on physical interfaces and logical ones, such as ones obtained through Virtual Private Networks (VPNs), Mobile IPv6, Realm Specific IP (RSIP) etc.

    At this point this class only supports UDP candidates. Implementation of support for other transport protocols should mean that this class should become abstract and some transport specific components like to socket for example should be brought down the inheritance chain.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      IceSocketWrapper getCandidateIceSocketWrapper() SHOULD NOT be used outside ice4j.

      • Methods inherited from class org.ice4j.ice.LocalCandidate

        getDatagramSocket, getExtendedType, 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, getFoundation, getHostAddress, getMappedAddress, getParentComponent, getPriority, getReflexiveAddress, getRelatedAddress, getRelatedCandidate, getRelayServerAddress, getRelayedAddress, getStunServerAddress, getTcpType, getTransport, getTransportAddress, getType, hashCode, isVirtual, setBase, setCandidateType, setFoundation, setTcpType, setVirtual, toShortString, toString

      • Methods inherited from class java.lang.Comparable

        compareTo

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • HostCandidate

        HostCandidate(IceSocketWrapper socket, Component parentComponent)
        Creates a HostCandidate for the specified transport address.
        Parameters:
        socket - the DatagramSocket that communication associated with this Candidate will be going through.
        parentComponent - the Component that this candidate belongs to.

      • HostCandidate

        HostCandidate(TransportAddress transportAddress, Component parentComponent)
        Creates a HostCandidate for the specified transport address.
        Parameters:
        transportAddress - the transport address for the new HostCandidate.
        parentComponent - the Component that this candidate belongs to.

      • HostCandidate

        HostCandidate(IceSocketWrapper socket, Component parentComponent, Transport transport)
        Creates a HostCandidate for the specified transport address.
        Parameters:
        socket - the DatagramSocket that communication associated with this Candidate will be going through.
        parentComponent - the Component that this candidate belongs to.
        transport - transport protocol used