Buttplug.Core.Connector

Provides methods of connecting to a Buttplug Server

Documentation

class Connector c where

Abstracts over methods of connecting to a buttplug server. The connector contains all the information necessary for establishing a connection.

Associated Types

type Connection c = conn | conn -> c

A Connector determines a unique connection type that is used for communication.

Methods

runClient :: c -> (Connection c -> IO a) -> IO a

Main entry point for communicating with the Buttplug server. Establish a connection to the server and pass the connection handle to the continuation.

sendMessages :: Connection c -> [Message] -> IO ()

Send Messages to the server. In the Buttplug protocol, all messages are wrapped in a JSON array (here a Haskell list) to facilitate sending multiple messages simultaneously. Use sendMessage to send a single message.

receiveMsgs :: Connection c -> IO [Message]

receive Messages from the server

Instances

Connector WebSocketConnector

Defined in Buttplug.Core.Connector

Associated Types

type Connection WebSocketConnector = (conn :: Type)

Methods

runClient :: WebSocketConnector -> (Connection WebSocketConnector -> IO a) -> IO a

sendMessages :: Connection WebSocketConnector -> [Message] -> IO ()

receiveMsgs :: Connection WebSocketConnector -> IO [Message]

sendMessage :: forall c. Connector c => Connection c -> Message -> IO ()

Send the server a single Message

data WebSocketConnector

Connect to the buttplug server using websockets

Constructors

InsecureWebSocketConnector

Fields

• insecureWSConnectorHost :: String
• insecureWSConnectorPort :: Int

SecureWebSocketConnector

Fields

• secureWSConnectorHost :: String
• secureWSConnectorPort :: PortNumber
• secureWSBypassCertVerify :: Bool

Instances

Connector WebSocketConnector

Defined in Buttplug.Core.Connector

Associated Types

type Connection WebSocketConnector = (conn :: Type)

Methods

runClient :: WebSocketConnector -> (Connection WebSocketConnector -> IO a) -> IO a

sendMessages :: Connection WebSocketConnector -> [Message] -> IO ()

receiveMsgs :: Connection WebSocketConnector -> IO [Message]

type Connection WebSocketConnector

Defined in Buttplug.Core.Connector

type Connection WebSocketConnector = Connection

data ConnectorException

An exception type abstracting over the exceptions that might arise in the course of communication with the buttplug server. Connector instances in general should throw these rather than Exceptions specific to the connection type.

Constructors

ConnectionFailed String

UnexpectedConnectionClosed

ConnectionClosedNormally

ReceivedInvalidMessage ByteString

OtherConnectorError String

Instances

Show ConnectorException

Defined in Buttplug.Core.Connector

Methods

showsPrec :: Int -> ConnectorException -> ShowS

show :: ConnectorException -> String

showList :: [ConnectorException] -> ShowS

Exception ConnectorException

Defined in Buttplug.Core.Connector

Methods

toException :: ConnectorException -> SomeException

fromException :: SomeException -> Maybe ConnectorException

displayException :: ConnectorException -> String

handleWSConnFailed :: HandshakeException -> IO a

Convert HandshakeException into ConnectionFailed

handleSockConnFailed :: IOError -> IO a

Convert socket connection issues into ConnectionFailed

handleWSConnException :: ConnectionException -> IO a

Convert websocket specific connection exceptions into ConnectorException