Package org.ice4j.ice

Enum NominationStrategy

  • All Implemented Interfaces:
    
public enum NominationStrategy

    Contains the nomination strategies currently supported by this implementation's DefaultNominator class. Applications can either pick one of these strategies or select NONE in case they want to handle nominations themselves.

    Note that NominationStrategies are an ice4j concept and they are not mentioned in RFC 5245.

    Author:

    Emil Ivov

    • 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
      NONE

      Indicates that ice4j's nominator should nominate valid pairs and that the application will be handling this.
      NOMINATE_FIRST_VALID

      The strategy consists in nominating the first candidate pair that's confirmed as valid.
      NOMINATE_HIGHEST_PRIO

      The strategy consists in nominating the highest priority valid pair. Once a pair is validated, if no higher-priority pairs remain outstanding, it is nominated; otherwise, a timer is armed, and if higher-priority pairs are still outstanding after the timeout, the highest-priority validated pair is nominated.
      NOMINATE_FIRST_HOST_OR_REFLEXIVE_VALID

      The strategy consists in nominating the first host or server reflexive that's confirmed as valid pair. When a relayed candidate pair is validated first, a timer is armed and only if no host or server reflexive pair gets validated prior to timeout, the relayed ones gets nominated.
      NOMINATE_BEST_RTT

      The strategy consists in nominating the pair that showed the best shortest round trip time once all checks in a list completed.

    • Method Summary

      Modifier and Type Method Description
      String toString() Returns the name of this NominationStrategy.
      static NominationStrategy fromString(String string)
      static Array<NominationStrategy> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static NominationStrategy valueOf(String name) Returns the enum constant of this type with the specified 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 NominationStrategy.

        Returns:

        the name of this NominationStrategy.

      • values

         static Array<NominationStrategy> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static NominationStrategy valueOf(String name)

        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

        Returns:

        the enum constant with the specified name