Struct ButtplugServer 

pub struct ButtplugServer { /* private fields */ }

The server side of the Buttplug protocol. Frontend for connection to device management and communication.

Implementations

impl ButtplugServer

pub fn client_name(&self) -> Option<String>

pub fn spec_version(&self) -> Option<ButtplugMessageSpecVersion>

pub fn connection_state(&self) -> ConnectionState

Returns the current connection state.

pub fn event_stream( &self, ) -> impl Stream<Item = ButtplugServerMessageVariant> + use<>

Retreive an async stream of ButtplugServerMessages. This is how the server sends out non-query-related updates to the system, including information on devices being added/removed, client disconnection, etc…

pub fn server_version_event_stream( &self, ) -> impl Stream<Item = ButtplugServerMessageV4> + use<>

Retreive an async stream of ButtplugServerMessages, always at the latest available message spec. This is how the server sends out non-query-related updates to the system, including information on devices being added/removed, client disconnection, etc…

pub fn device_manager(&self) -> Arc<ServerDeviceManager>

Returns a references to the internal device manager, for handling configuration.

pub fn connected(&self) -> bool

If true, client is currently connected to the server.

pub fn disconnect(&self) -> BoxFuture<'_, Result<(), ErrorV0>>

Disconnects the server from a client, if it is connected.

pub fn shutdown(&self) -> ButtplugServerResultFuture

pub fn parse_message( &self, msg: ButtplugClientMessageVariant, ) -> BoxFuture<'static, Result<ButtplugServerMessageVariant, ButtplugServerMessageVariant>>

Sends a [ButtplugClientMessage] to be parsed by the server (for handshake or ping), or passed into the server’s [DeviceManager] for communication with devices.

pub fn parse_checked_message( &self, msg: ButtplugCheckedClientMessageV4, ) -> BoxFuture<'static, Result<ButtplugServerMessageV4, ErrorV0>>

Trait Implementations

impl Debug for ButtplugServer

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

Formats the value using the given formatter.