Struct Config 

pub struct Config {
    pub name: String,
    pub uri: String,
    pub timeout: f64,
    pub buffer: f64,
    pub throttle: f64,
    pub heartbeat: f64,
    pub data: Data,
}

Configuration for Game State Integration.

You can find more informations on VALVE’s wiki.

Fields

name: String

Service name.

It will be used to create the cfg filename, so it shouldn’t contain any spaces or special chars except _.

uri: String

The uri that will receive the payload.

The game will be making POST requests to this uri.

timeout: f64

Game expects an HTTP 2XX response code from its HTTP POST request, and game will not attempt submitting the next HTTP POST request while a previous request is still in flight. The game will consider the request as timed out if a response is not received within so many seconds, and will re-heartbeat next time with full state omitting any delta-computation.

buffer: f64

Because multiple game events tend to occur one after another very quickly, it is recommended to specify a non-zero buffer. When buffering is enabled, the game will collect events for so many seconds to report a bigger delta. For localhost service integration this is less of an issue and can be tuned to match the needs of the service or set to 0.0 to disable buffering completely.

throttle: f64

For high-traffic endpoints this setting will make the game client not send another request for at least this many seconds after receiving previous HTTP 2XX response to avoid notifying the service when game state changes too frequently.

heartbeat: f64

Even if no game state change occurs, this setting instructs the game to send a request so many seconds after receiving previous HTTP 2XX response. The service can be configured to consider game as offline or disconnected if it didn’t get a notification for a significant period of time exceeding the heartbeat interval.

data: Data

Subscribed Components.

Trait Implementations

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.