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

Enum 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, java.io.Serializable, java.lang.Comparable<EOS_ERelayControl>

public enum EOS_ERelayControl
extends java.lang.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.
Connections between clients using Incompatible settings may succeed in limited scenarios but should be treated as though they will consistently fail.

Information table

Type	EOS_RC_NoRelays	EOS_RC_AllowRelays (Default)	EOS_RC_ForceRelays
EOS_RC_NoRelays	Compatible	Compatible	Incompatible
EOS_RC_AllowRelays (Default)	Compatible	Compatible	Compatible
EOS_RC_ForceRelays	Incompatible	Compatible	Compatible

Since:

8/21/2023

Enum Constant Summary

Enum Constants

Enum Constant and Description
EOS_RC_AllowRelays Peer connections will attempt to use relay servers, but only after direct connection attempts fail.
EOS_RC_ForceRelays Peer connections will only ever use relay servers.
EOS_RC_NoRelays Peer connections will never attempt to use relay servers.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	fromNative(java.lang.Object nativeValue, com.sun.jna.FromNativeContext context)
java.lang.Class<?>	nativeType()
java.lang.Object	toNative()
static EOS_ERelayControl	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EOS_ERelayControl[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static EOS_ERelayControl[] values()

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

for (EOS_ERelayControl c : EOS_ERelayControl.values())
    System.out.println(c);

Returns:

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

valueOf

public static EOS_ERelayControl valueOf(java.lang.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.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

fromNative

public java.lang.Object fromNative(java.lang.Object nativeValue,
                                   com.sun.jna.FromNativeContext context)

Specified by:

fromNative in interface com.sun.jna.NativeMapped

toNative

public java.lang.Object toNative()

Specified by:

toNative in interface com.sun.jna.NativeMapped

nativeType

public java.lang.Class<?> nativeType()

Specified by:

nativeType in interface com.sun.jna.NativeMapped