Skip to main content

GameStateListener

Struct GameStateListener 

Source
pub struct GameStateListener { /* private fields */ }
Expand description

HTTP listener for CS2 GSI payloads.

Cheap to clone — every clone shares the same dispatcher and last-state cache. Handlers registered through any clone fire on every payload.

Implementations§

Source§

impl GameStateListener

Source

pub fn new(port: u16) -> Self

Create a listener that will bind to 127.0.0.1:<port> when started.

Source

pub fn with_addr(addr: SocketAddr) -> Self

Create a listener with a fully specified bind address.

Source

pub fn addr(&self) -> SocketAddr

The configured bind address. After start succeeds, this is also returned by actual_addr.

Source

pub fn actual_addr(&self) -> Option<SocketAddr>

The actual bound socket address — useful when you bind to port 0 and want to discover the OS-assigned port.

Source

pub fn on<E, F>(&self, handler: F) -> &Self
where E: Any + Send + Sync + 'static, F: Fn(&E) + Send + Sync + 'static,

Subscribe to a strongly typed event.

let gsl = GameStateListener::new(4000);
gsl.on(|e: &PlayerGotKill| {
    println!("{} now has {} round kills", e.player.name, e.new_round_kills);
});
Source

pub fn on_any<F>(&self, handler: F) -> &Self
where F: Fn(&GameEvent) + Send + Sync + 'static,

Subscribe to every event as a GameEvent.

Source

pub fn current_state(&self) -> Option<GameState>

The most recently received game state, if any.

Source

pub fn is_running(&self) -> bool

true once start has succeeded and before stop is called.

Source

pub async fn start(&self) -> Result<()>

Bind the listener and start accepting GSI payloads. Returns once the socket is bound — the actual serve loop runs as a background tokio task. Call stop to shut it down.

Source

pub async fn start_with_fallbacks<I>(&self, fallbacks: I) -> Result<()>
where I: IntoIterator<Item = SocketAddr>,

Bind, falling back to alternative addresses if the primary is busy.

Tries self.addr first. If that address is reported as in use (after the per-address retry budget is exhausted), each fallback is tried in turn. The first address that binds wins; the actual chosen address is then available via actual_addr.

Pass port = 0 as a final fallback to ask the OS to pick any free ephemeral port — that bind effectively cannot fail.

All non-AddrInUse errors short-circuit immediately (no point trying fallbacks if e.g. the loopback interface is gone).

Source

pub async fn stop(&self) -> Result<()>

Signal the serve loop to exit and wait for it to finish.

Trait Implementations§

Source§

impl Clone for GameStateListener

Source§

fn clone(&self) -> GameStateListener

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more