Struct buttplug::server::ButtplugServerBuilder

pub struct ButtplugServerBuilder { /* private fields */ }

Configures and creates ButtplugServer instances.

Implementations

impl ButtplugServerBuilder

pub fn name(&mut self, name: &str) -> &mut Self

Set the name of the server, which is relayed to the client on connection (mostly for confirmation in UI dialogs)

pub fn max_ping_time(&mut self, ping_time: u32) -> &mut Self

Set the maximum ping time, in milliseconds, for the server. If the server does not receive a Ping message in this amount of time after the handshake has succeeded, the server will automatically disconnect. If this is not called, the ping timer will not be activated.

Note that this has nothing to do with communication medium specific pings, like those built into the Websocket protocol. This ping is specific to the Buttplug protocol.

pub fn device_configuration_json( &mut self, config_json: Option<String> ) -> &mut Self

Set the device configuration json file contents, to be loaded during build.

pub fn user_device_configuration_json( &mut self, config_json: Option<String> ) -> &mut Self

Set the user device configuration json file contents, to be loaded during build.

pub fn comm_manager<T>(&mut self, builder: T) -> &mut Self

where T: HardwareCommunicationManagerBuilder + 'static,

pub fn allowed_address(&mut self, address: &str) -> &mut Self

pub fn denied_address(&mut self, address: &str) -> &mut Self

pub fn reserved_index( &mut self, identifier: &ServerDeviceIdentifier, index: u32 ) -> &mut Self

pub fn protocol_factory<T>(&mut self, factory: T) -> &mut Self

where T: ProtocolIdentifierFactory + 'static,

pub fn communication_specifier( &mut self, protocol_name: &str, specifier: ProtocolCommunicationSpecifier ) -> &mut Self

pub fn protocol_attributes( &mut self, identifier: ProtocolAttributesIdentifier, attributes: ProtocolDeviceAttributes ) -> &mut Self

pub fn skip_default_protocols(&mut self) -> &mut Self

pub fn allow_raw_messages(&mut self) -> &mut Self

pub fn finish(&mut self) -> Result<ButtplugServer, ButtplugServerError>

Try to build a ButtplugServer using the parameters given.

Trait Implementations

impl Default for ButtplugServerBuilder

fn default() -> Self

Returns the “default value” for a type.