EOS API reference page for EOS_ERelayControl


This enumerated type is part of the P2P Interface.


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 | +------------------------------+---------------------+-------------------------------+---------------------+



Enumerated ValueMeaning
EOS_RC_NoRelaysPeer connections will never attempt to use relay servers. Clients with restrictive NATs may not be able to connect to peers.
EOS_RC_AllowRelaysPeer connections will attempt to use relay servers, but only after direct connection attempts fail. This is the default value if not changed.
EOS_RC_ForceRelaysPeer connections will only ever use relay servers. This will add latency to all connections, but will hide IP Addresses from peers.