Package io.github.blackspherefollower.buttplug4j.client

Class ButtplugClient

java.lang.Object

io.github.blackspherefollower.buttplug4j.client.ButtplugClient

public abstract class ButtplugClient
extends Object

ButtplugClient is the abstract class containing the bulk of the logic for communicating with the Buttplug.io sever Intiface Central.

The transport logic is not in this package, as the various websocket libraries have differing requirements that will not fit all use-cases. In general, the Java8 compatible Jetty Websocket Client connector will meet the needs of most users: see tinyurl.com/buttplug4j

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ButtplugClient.ConnectionState	Connection state enum.

Constructor Summary

Constructors

Constructor	Description
ButtplugClient(String aClientName)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract void	cleanup()	Cleanup resources.
final void	disconnect()	Disconnect the client.
protected final void	doHandshake()	Perform the handshake with the server.
final ButtplugClient.ConnectionState	getConnectionState()	Get the connection state.
final IDeviceAddedEvent	getDeviceAddedHandler()	Get the device added handler.
final IDeviceChangedEvent	getDeviceChanged()	Get the device changed handler.
final IDeviceRemovedEvent	getDeviceRemovedHandler()	Get the device removed handler.
final List<ButtplugClientDevice>	getDevices()	Get the list of connected devices.
final IErrorEvent	getErrorHandler()	Get the error handler.
final IInputEvent	getInputHandler()	Get the input handler.
final int	getNextMsgId()	Get the next message ID.
final IConnectedEvent	getOnConnectedHandler()	Get the connected handler.
protected final ButtplugJsonMessageParser	getParser()	Get the JSON parser.
final IScanningEvent	getScanningFinishedHandler()	Get the scanning finished handler.
final boolean	isConnected()	Check if the client is connected.
final void	onMessage(List<ButtplugMessage> msgs)	Called when a list of messages is received.
final void	requestDeviceList()	Request the device list from the server.
protected final CompletableFuture<ButtplugMessage>	scheduleWait(int id, CompletableFuture<ButtplugMessage> promise)	Schedule a wait for a message response.
final CompletableFuture<ButtplugMessage>	sendDeviceMessage(ButtplugClientDevice device, ButtplugDeviceMessage deviceMsg)	Send a device message.
protected abstract CompletableFuture<ButtplugMessage>	sendMessage(ButtplugMessage msg)	Send a message.
protected final void	setConnectionState(ButtplugClient.ConnectionState connectionState)	Set the connection state.
final void	setDeviceAddedHandler(IDeviceAddedEvent deviceAddedHandler)	Set the device added handler.
final void	setDeviceChangedHandler(IDeviceChangedEvent deviceChangedHandler)	Set the device changed handler.
final void	setDeviceRemovedHandler(IDeviceRemovedEvent deviceRemovedHandler)	Set the device removed handler.
final void	setErrorHandler(IErrorEvent errorReceivedHandler)	Set the error handler.
final void	setInputHandler(IInputEvent inputHandler)	Set the input handler.
final void	setOnConnected(IConnectedEvent onConnected)	Set the connected handler.
final void	setScanningFinishedHandler(IScanningEvent scanningFinishedHandler)	Set the scanning finished handler.
final boolean	startScanning()	Start scanning for devices.
final Future<ButtplugMessage>	startScanningAsync()	Start scanning for devices asynchronously.
final boolean	stopAllDevices()	Stop all devices.
final boolean	stopAllDevices(boolean inputs, boolean outputs)	Stop all devices.
final Future<ButtplugMessage>	stopAllDevicesAsync()	Stop all devices asynchronously.
final Future<ButtplugMessage>	stopAllDevicesAsync(boolean inputs, boolean outputs)	Stop all devices asynchronously.
final boolean	stopScanning()	Stop scanning for devices.
final Future<ButtplugMessage>	stopScanningAsync()	Stop scanning for devices asynchronously.
protected final boolean	waitForOk(Future<ButtplugMessage> msg)	Wait for an Ok message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ButtplugClient

public ButtplugClient(String aClientName)

Constructor.

Parameters:

aClientName - client name

Method Details

getParser

protected final ButtplugJsonMessageParser getParser()

Get the JSON parser.

Returns:

parser

getConnectionState

public final ButtplugClient.ConnectionState getConnectionState()

Get the connection state.

Returns:

connection state

setConnectionState

protected final void setConnectionState(ButtplugClient.ConnectionState connectionState)

Set the connection state.

Parameters:

connectionState - connection state

isConnected

public final boolean isConnected()

Check if the client is connected.

Returns:

true if connected

getNextMsgId

public final int getNextMsgId()

Get the next message ID.

Returns:

message ID

onMessage

public final void onMessage(List<ButtplugMessage> msgs)

Called when a list of messages is received.

Parameters:

msgs - messages

doHandshake

protected final void doHandshake()

Perform the handshake with the server.

requestDeviceList

public final void requestDeviceList()
                             throws ButtplugClientException,
ExecutionException,
InterruptedException,
TimeoutException

Request the device list from the server.

Throws:

ButtplugClientException - if an error occurs

ExecutionException - if an error occurs

InterruptedException - if an error occurs

TimeoutException - if an error occurs

getDevices

public final List<ButtplugClientDevice> getDevices()

Get the list of connected devices.

Returns:

devices

startScanning

public final boolean startScanning()
                            throws ExecutionException,
InterruptedException,
IOException,
TimeoutException

Start scanning for devices.

Returns:

true if successful

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

IOException - if an error occurs

TimeoutException - if an error occurs

startScanningAsync

public final Future<ButtplugMessage> startScanningAsync()

Start scanning for devices asynchronously.

Returns:

future

stopScanning

public final boolean stopScanning()
                           throws ExecutionException,
InterruptedException,
TimeoutException

Stop scanning for devices.

Returns:

true if successful

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

TimeoutException - if an error occurs

stopScanningAsync

public final Future<ButtplugMessage> stopScanningAsync()

Stop scanning for devices asynchronously.

Returns:

future

stopAllDevices

public final boolean stopAllDevices()
                             throws ExecutionException,
InterruptedException,
IOException,
TimeoutException

Stop all devices.

Returns:

true if successful

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

IOException - if an error occurs

TimeoutException - if an error occurs

stopAllDevices

public final boolean stopAllDevices(boolean inputs,
 boolean outputs)
                             throws ExecutionException,
InterruptedException,
IOException,
TimeoutException

Stop all devices.

Parameters:

inputs - stop inputs

outputs - stop outputs

Returns:

true if successful

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

IOException - if an error occurs

TimeoutException - if an error occurs

stopAllDevicesAsync

public final Future<ButtplugMessage> stopAllDevicesAsync()

Stop all devices asynchronously.

Returns:

future

stopAllDevicesAsync

public final Future<ButtplugMessage> stopAllDevicesAsync(boolean inputs,
 boolean outputs)

Stop all devices asynchronously.

Parameters:

inputs - stop inputs

outputs - stop outputs

Returns:

future

sendDeviceMessage

public final CompletableFuture<ButtplugMessage> sendDeviceMessage(ButtplugClientDevice device,
 ButtplugDeviceMessage deviceMsg)

Send a device message.

Parameters:

device - device

deviceMsg - message

Returns:

future

waitForOk

protected final boolean waitForOk(Future<ButtplugMessage> msg)
                           throws ExecutionException,
InterruptedException,
TimeoutException

Wait for an Ok message.

Parameters:

msg - message future

Returns:

true if Ok

Throws:

ExecutionException - if an error occurs

InterruptedException - if an error occurs

TimeoutException - if an error occurs

sendMessage

protected abstract CompletableFuture<ButtplugMessage> sendMessage(ButtplugMessage msg)

Send a message.

Parameters:

msg - message

Returns:

future

getDeviceAddedHandler

public final IDeviceAddedEvent getDeviceAddedHandler()

Get the device added handler.

Returns:

handler

setDeviceAddedHandler

public final void setDeviceAddedHandler(IDeviceAddedEvent deviceAddedHandler)

Set the device added handler.

Parameters:

deviceAddedHandler - handler

getDeviceChanged

public final IDeviceChangedEvent getDeviceChanged()

Get the device changed handler.

Returns:

handler

setDeviceChangedHandler

public final void setDeviceChangedHandler(IDeviceChangedEvent deviceChangedHandler)

Set the device changed handler.

Parameters:

deviceChangedHandler - handler

getDeviceRemovedHandler

public final IDeviceRemovedEvent getDeviceRemovedHandler()

Get the device removed handler.

Returns:

handler

setDeviceRemovedHandler

public final void setDeviceRemovedHandler(IDeviceRemovedEvent deviceRemovedHandler)

Set the device removed handler.

Parameters:

deviceRemovedHandler - handler

getScanningFinishedHandler

public final IScanningEvent getScanningFinishedHandler()

Get the scanning finished handler.

Returns:

handler

setScanningFinishedHandler

public final void setScanningFinishedHandler(IScanningEvent scanningFinishedHandler)

Set the scanning finished handler.

Parameters:

scanningFinishedHandler - handler

getErrorHandler

public final IErrorEvent getErrorHandler()

Get the error handler.

Returns:

handler

setErrorHandler

public final void setErrorHandler(IErrorEvent errorReceivedHandler)

Set the error handler.

Parameters:

errorReceivedHandler - handler

getInputHandler

public final IInputEvent getInputHandler()

Get the input handler.

Returns:

handler

setInputHandler

public final void setInputHandler(IInputEvent inputHandler)

Set the input handler.

Parameters:

inputHandler - handler

getOnConnectedHandler

public final IConnectedEvent getOnConnectedHandler()

Get the connected handler.

Returns:

handler

setOnConnected

public final void setOnConnected(IConnectedEvent onConnected)

Set the connected handler.

Parameters:

onConnected - handler

cleanup

protected abstract void cleanup()

Cleanup resources.

disconnect

public final void disconnect()

Disconnect the client.

scheduleWait

protected final CompletableFuture<ButtplugMessage> scheduleWait(int id,
 CompletableFuture<ButtplugMessage> promise)

Schedule a wait for a message response.

Parameters:

id - message ID

promise - promise

Returns:

future