Struct steamworks::networking_utils::RelayNetworkStatus

pub struct RelayNetworkStatus { /* private fields */ }

Implementations

impl RelayNetworkStatus

pub fn availability(&self) -> NetworkingAvailabilityResult

Summary status. When this is “current”, initialization has completed. Anything else means you are not ready yet, or there is a significant problem.

pub fn is_ping_measurement_in_progress(&self) -> bool

True if latency measurement is in progress (or pending, awaiting a prerequisite).

pub fn network_config(&self) -> NetworkingAvailabilityResult

Status obtaining the network config. This is a prerequisite for relay network access.

Failure to obtain the network config almost always indicates a problem with the local internet connection.

pub fn any_relay(&self) -> NetworkingAvailabilityResult

Current ability to communicate with ANY relay. Note that the complete failure to communicate with any relays almost always indicates a problem with the local Internet connection. (However, just because you can reach a single relay doesn’t mean that the local connection is in perfect health.)

pub fn debugging_message(&self) -> &str

Non-localized English language status. For diagnostic/debugging purposes only.

Trait Implementations

impl From<SteamRelayNetworkStatus_t> for RelayNetworkStatus

fn from(status: SteamRelayNetworkStatus_t) -> Self

Converts to this type from the input type.