[][src]Crate fleetspeak

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

Packet

A Fleetspeak client communication packet.

Enums

ReadError

An error type for failures that occurred when receiving a message.

WriteError

An error type for failures that occured when sending a message.

Functions

collect

Collects a message from the Fleetspeak server.

heartbeat

Sends a heartbeat signal to the Fleetspeak client.

receive

Receives a message from the Fleetspeak server.

send

Sends the message to the Fleetspeak server.

startup

Sends a system message with startup information to the Fleetspeak client.