Struct gns_sys::SteamRelayNetworkStatus_t

#[repr(C)]
pub struct SteamRelayNetworkStatus_t {
    pub m_eAvail: ESteamNetworkingAvailability,
    pub m_bPingMeasurementInProgress: c_int,
    pub m_eAvailNetworkConfig: ESteamNetworkingAvailability,
    pub m_eAvailAnyRelay: ESteamNetworkingAvailability,
    pub m_debugMsg: [c_char; 256],
}

A struct used to describe our readiness to use the relay network. To do this we first need to fetch the network configuration, which describes what POPs are available.

Fields

m_eAvail: ESteamNetworkingAvailability

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

m_bPingMeasurementInProgress: c_int

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

m_eAvailNetworkConfig: ESteamNetworkingAvailability

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.

m_eAvailAnyRelay: ESteamNetworkingAvailability

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.)

m_debugMsg: [c_char; 256]

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

Trait Implementations

impl Clone for SteamRelayNetworkStatus_t

fn clone(&self) -> SteamRelayNetworkStatus_t

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SteamRelayNetworkStatus_t

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SteamRelayNetworkStatus_t

fn default() -> Self

Returns the “default value” for a type.

impl Hash for SteamRelayNetworkStatus_t

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for SteamRelayNetworkStatus_t

fn cmp(&self, other: &SteamRelayNetworkStatus_t) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<SteamRelayNetworkStatus_t> for SteamRelayNetworkStatus_t

fn eq(&self, other: &SteamRelayNetworkStatus_t) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SteamRelayNetworkStatus_t) -> bool

This method tests for !=.

impl PartialOrd<SteamRelayNetworkStatus_t> for SteamRelayNetworkStatus_t

fn partial_cmp(&self, other: &SteamRelayNetworkStatus_t) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for SteamRelayNetworkStatus_t

impl Eq for SteamRelayNetworkStatus_t

impl StructuralEq for SteamRelayNetworkStatus_t

impl StructuralPartialEq for SteamRelayNetworkStatus_t