Expand description
A Fleetspeak client connector library.
This library exposes a set of functions for writing client-side Fleetspeak services. Each of these functions operates on a global connection object that is lazily established. If this global connection cannot be established, the library will panic (because without this connection Fleetspeak will shut the service down anyway).
Note that each service should send startup information upon its inception and continue to heartbeat from time to time to notify the Fleetspeak client that it did not get stuck.
Structs§
- Message
- A Fleetspeak client communication message.
Functions§
- heartbeat
- Sends a heartbeat signal to the Fleetspeak client.
- heartbeat_
with_ throttle - Sends a heartbeat signal to the Fleetspeak client but no more frequently
than the specified
rate. - receive
- Receives a message from the Fleetspeak server.
- receive_
with_ heartbeat - Receive a message from the Fleetspeak server, heartbeating in background.
- send
- Sends the message to the Fleetspeak server.
- startup
- Sends a system message with startup information to the Fleetspeak client.