Package 

Enum CandidateType

  • All Implemented Interfaces:
    java.io.Serializable , java.lang.Comparable 
    
public enum CandidateType

    According to the ICE specification, Candidates have a type property which makes them server reflexive, peer reflexive, relayed or host).

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      STUN_CANDIDATE

      A Server Reflexive Candidate is a candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a packet through the NAT to a server. Server reflexive candidates can be learned by STUN servers using the Binding Request, or TURN servers, which provides both a Relayed and Server Reflexive candidate. This is the old name for "srflx".
      LOCAL_CANDIDATE

      A candidate obtained by binding to a specific port from an interface on the host. This includes both physical interfaces and logical ones, such as ones obtained through Virtual Private Networks (VPNs) and Realm Specific IP (RSIP) [RFC3102] (which lives at the operating system level). This is the old name for "host".
      HOST_CANDIDATE

      A candidate obtained by binding to a specific port from an interface on the host. This includes both physical interfaces and logical ones, such as ones obtained through Virtual Private Networks (VPNs) and Realm Specific IP (RSIP) [RFC3102] (which lives at the operating system level).
      RELAYED_CANDIDATE

      A Relayed Candidate is a candidate obtained by sending a TURN Allocate request from a host candidate to a TURN server. The relayed candidate is resident on the TURN server, and the TURN server relays packets back towards the agent.
      SERVER_REFLEXIVE_CANDIDATE

      A Server Reflexive Candidate is a candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a packet through the NAT to a server. Server reflexive candidates can be learned by STUN servers using the Binding Request, or TURN servers, which provides both a Relayed and Server Reflexive candidate.
      PEER_REFLEXIVE_CANDIDATE

      Peer Reflexive Candidate: A candidate whose IP address and port are a binding allocated by a NAT for an agent when it sent a STUN Binding Request through the NAT to its peer.

    • Method Summary

      Modifier and Type Method Description
      String toString() Returns the name of this CandidateType (e.g.
      static CandidateType parse(String candidateTypeName) Returns a CandidateType instance corresponding to the specified candidateTypeName.
      static Array<CandidateType> values()
      static CandidateType valueOf(String name)

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • toString

         String toString()

        Returns the name of this CandidateType (e.g. "host", "prflx", "srflx", or "relay").

      • parse

         static CandidateType parse(String candidateTypeName)

        Returns a CandidateType instance corresponding to the specified candidateTypeName. For example, for name "host", this method would return HOST_CANDIDATE.

        Parameters:
        candidateTypeName - the name that we'd like to parse.