Package 

Class RemoteCandidate

  • All Implemented Interfaces:
    java.lang.Comparable 
    
public class RemoteCandidate
extends Candidate<RemoteCandidate>

    RemoteCandidates are candidates that an agent received in an offer or an answer from its peer, and that it would use to form candidate pairs after combining them with its local candidates.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private String ufrag

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      String getUfrag() Get the remote ufrag.
      void setPriority(long priority) Sets the priority of this RemoteCandidate.
      boolean isDefault() Determines whether this Candidate is the default one for its parent component.

      • 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

      • RemoteCandidate

        RemoteCandidate(TransportAddress transportAddress, Component parentComponent, CandidateType type, String foundation, long priority, RemoteCandidate relatedCandidate)
        Creates a RemoteCandidate instance for the specified transport address and properties.
        Parameters:
        transportAddress - the transport address that this candidate is encapsulating.
        parentComponent - the Component that this candidate belongs to.
        type - the CandidateType for this Candidate.
        foundation - the RemoteCandidate's foundation as reported by the session description protocol.
        priority - the RemoteCandidate's priority as reported by the session description protocol.
        relatedCandidate - the relatedCandidate: null for a host candidate, the base address (host candidate) for a reflexive candidate, the mapped address (the mapped address of the TURN allocate response) for a relayed candidate.

      • RemoteCandidate

        RemoteCandidate(TransportAddress transportAddress, Component parentComponent, CandidateType type, String foundation, long priority, RemoteCandidate relatedCandidate, String ufrag)
        Creates a RemoteCandidate instance for the specified transport address and properties.
        Parameters:
        transportAddress - the transport address that this candidate is encapsulating.
        parentComponent - the Component that this candidate belongs to.
        type - the CandidateType for this Candidate.
        foundation - the RemoteCandidate's foundation as reported by the session description protocol.
        priority - the RemoteCandidate's priority as reported by the session description protocol.
        relatedCandidate - the relatedCandidate: null for a host candidate, the base address (host candidate) for a reflexive candidate, the mapped address (the mapped address of the TURN allocate response) for a relayed candidate.
        ufrag - ufrag for the remote candidate

    • Method Detail

      • setPriority

         void setPriority(long priority)

        Sets the priority of this RemoteCandidate. Priority is a unique priority number that MUST be a positive integer between 1 and (2**32 - 1). This priority will be set and used by ICE algorithms to determine the order of the connectivity checks and the relative preference for candidates.

        Parameters:
        priority - the priority number between 1 and (2**32 - 1).

      • isDefault

         boolean isDefault()

        Determines whether this Candidate is the default one for its parent component.