Package host.anzo.eossdk.eos.sdk.p2p.enums

Enum Class EOS_ERelayControl

java.lang.Object
java.lang.Enum<EOS_ERelayControl>
host.anzo.eossdk.eos.sdk.p2p.enums.EOS_ERelayControl
All Implemented Interfaces:
com.sun.jna.NativeMapped, Serializable, Comparable<EOS_ERelayControl>, Constable
public enum EOS_ERelayControl extends Enum<EOS_ERelayControl> implements com.sun.jna.NativeMapped
Setting for controlling whether relay servers are used.

Please see the following EOS_ERelayControl value compatibility-chart to better understand how changing this value can affect compatibility between clients with different settings. 

 
 +------------------------------+---------------------+-------------------------------+---------------------+
 |                              |   EOS_RC_NoRelays   |  EOS_RC_AllowRelays (Default) |  EOS_RC_ForceRelays |
 +------------------------------+---------------------+-------------------------------+---------------------
 | EOS_RC_NoRelays              |  Compatible         |  Compatible                   |  Connection Failure |
 | EOS_RC_AllowRelays (Default) |  Compatible         |  Compatible                   |  Compatible         |
 | EOS_RC_ForceRelays           |  Connection Failure |  Compatible                   |  Compatible         |
 +------------------------------+---------------------+-------------------------------+---------------------+
Since:
8/21/2023

  • Enum Constant Details

    • EOS_RC_NoRelays

      public static final EOS_ERelayControl EOS_RC_NoRelays
      Peer connections will never attempt to use relay servers. Clients with restrictive NATs may not be able to connect to peers.

    • EOS_RC_AllowRelays

      public static final EOS_ERelayControl EOS_RC_AllowRelays
      Peer connections will attempt to use relay servers, but only after direct connection attempts fail. This is the default value if not changed.

    • EOS_RC_ForceRelays

      public static final EOS_ERelayControl EOS_RC_ForceRelays
      Peer connections will only ever use relay servers. This will add latency to all connections, but will hide IP Addresses from peers.

  • Method Details

    • values

      public static EOS_ERelayControl[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EOS_ERelayControl valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • fromNative

      public Object fromNative(Object nativeValue, com.sun.jna.FromNativeContext context)
      Specified by:
      fromNative in interface com.sun.jna.NativeMapped

    • toNative

      public Object toNative()
      Specified by:
      toNative in interface com.sun.jna.NativeMapped

    • nativeType

      public Class<?> nativeType()
      Specified by:
      nativeType in interface com.sun.jna.NativeMapped