1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

// Buttplug Rust Source Code File - See https://buttplug.io for more info.
//
// Copyright 2016-2022 Nonpolynomial Labs LLC. All rights reserved.
//
// Licensed under the BSD 3-Clause license. See LICENSE file in the project root
// for full license information.

//! Utility module, for storing types and functions used across other modules in
//! the library.

pub mod async_manager;
#[cfg(feature = "server")]
pub mod device_configuration;
pub mod future;
pub mod json;
pub mod logging;
pub mod stream;

#[cfg(not(feature = "wasm"))]
pub use tokio::time::sleep;
#[cfg(feature = "wasm")]
pub use wasmtimer::tokio::sleep;

#[cfg(all(feature = "server", feature = "client"))]
use crate::{
  client::ButtplugClient,
  core::connector::ButtplugInProcessClientConnectorBuilder,
  server::ButtplugServerBuilder,
};

/// Convenience function for creating in-process connectors.
///
/// Creates a [ButtplugClient] event loop, with an in-process connector with
/// all device managers that ship with the library and work on the current
/// platform added to it already. Takes a maximum ping time to build the
/// server with, other parameters match `run()`.
///
/// # When To Use This Instead of `run()`
///
/// If you just want to build a quick example and save yourself a few use
/// statements and setup, this will get you going. For anything *production*,
/// we recommend using `run()` as you will have more control over what
/// happens. This method may gain/lose device comm managers at any time.
///
/// # The Device I Want To Use Doesn't Show Up
///
/// If you are trying to use this method to create your client, and do not see
/// the devices you want, there are a couple of things to check:
///
/// - Are you on a platform that the device communication manager supports?
///   For instance, we only support XInput on windows.
/// - Did the developers add a new Device CommunicationManager type and forget
///   to add it to this method? _It's more likely than you think!_ [File a
///   bug](https://github.com/buttplugio/buttplug-rs/issues).
///
/// # Errors
///
/// If the library was compiled without any device managers, the
/// [ButtplugClient] will have nothing to do. This is considered a
/// catastrophic failure and the library will return an error.
///
/// If the library is using outside device managers, it is recommended to
/// build your own connector, add your device manager to those, and use the
/// `run()` method to pass it in.
#[cfg(all(feature = "server", feature = "client"))]
pub async fn in_process_client(client_name: &str, allow_raw_messages: bool) -> ButtplugClient {
  let mut server_builder = ButtplugServerBuilder::default();

  #[cfg(all(
    feature = "btleplug-manager",
    any(
      target_os = "windows",
      target_os = "macos",
      target_os = "linux",
      target_os = "ios",
      target_os = "android"
    )
  ))]
  {
    use crate::server::device::hardware::communication::btleplug::BtlePlugCommunicationManagerBuilder;
    server_builder.comm_manager(BtlePlugCommunicationManagerBuilder::default());
  }
  #[cfg(feature = "websocket-server-manager")]
  {
    use crate::server::device::hardware::communication::websocket_server::websocket_server_comm_manager::WebsocketServerDeviceCommunicationManagerBuilder;
    server_builder.comm_manager(
      WebsocketServerDeviceCommunicationManagerBuilder::default().listen_on_all_interfaces(true),
    );
  }
  #[cfg(all(
    feature = "serial-manager",
    any(target_os = "windows", target_os = "macos", target_os = "linux")
  ))]
  {
    use crate::server::device::hardware::communication::serialport::SerialPortCommunicationManagerBuilder;
    server_builder.comm_manager(SerialPortCommunicationManagerBuilder::default());
  }
  #[cfg(feature = "lovense-connect-service-manager")]
  {
    use crate::server::device::hardware::communication::lovense_connect_service::LovenseConnectServiceCommunicationManagerBuilder;
    server_builder.comm_manager(LovenseConnectServiceCommunicationManagerBuilder::default());
  }
  #[cfg(all(
    feature = "lovense-dongle-manager",
    any(target_os = "windows", target_os = "macos", target_os = "linux")
  ))]
  {
    use crate::server::device::hardware::communication::lovense_dongle::{
      LovenseHIDDongleCommunicationManagerBuilder,
      LovenseSerialDongleCommunicationManagerBuilder,
    };
    server_builder.comm_manager(LovenseHIDDongleCommunicationManagerBuilder::default());
    server_builder.comm_manager(LovenseSerialDongleCommunicationManagerBuilder::default());
  }
  #[cfg(all(feature = "xinput-manager", target_os = "windows"))]
  {
    use crate::server::device::hardware::communication::xinput::XInputDeviceCommunicationManagerBuilder;
    server_builder.comm_manager(XInputDeviceCommunicationManagerBuilder::default());
  }
  if allow_raw_messages {
    server_builder.allow_raw_messages();
  }
  let server = server_builder.finish().unwrap();
  let connector = ButtplugInProcessClientConnectorBuilder::default()
    .server(server)
    .finish();
  let client = ButtplugClient::new(client_name);
  client.connect(connector).await.unwrap();
  client
}