Modulehosc-0.21.1Haskell2010

Sound.Osc.Transport.Monad

Monad class implementing an Open Sound Control transport.

Contents

Send
Receive
Wait

Synopsis

class SendOsc
class RecvOsc
class DuplexOsc
class Transport
type Connection
value withTransport
value withTransport_
value sendMessage
value sendBundle
value recvBundle
value recvMessage
value recvMessage_err
value recvMessages
value waitUntil
value waitFor
value waitImmediate
value waitMessage
value waitAddress
value waitReply
value waitDatum

Packagehosc-0.21.1
Exports20
LanguageHaskell2010
LicenceGPL-3.0-only
SourceMonad.hs

classclass Monad m => SendOsc (m :: Type -> Type) where

Source#

Sender monad.

Methods

sendPacket :: PacketOf Message -> m ()
Encode and send an Osc packet.

Instances1SendOsc

(Transport t, MonadIO io) => SendOsc (ReaderT t io)Defined in hosc-0.21.1 · Sound.Osc.Transport.Monad
SendOsc over ReaderT.

classclass Monad m => RecvOsc (m :: Type -> Type) where

Source#

Receiver monad.

Methods

recvPacket :: m (PacketOf Message)
Receive and decode an Osc packet.

Instances1RecvOsc

(Transport t, MonadIO io) => RecvOsc (ReaderT t io)Defined in hosc-0.21.1 · Sound.Osc.Transport.Monad
RecvOsc over ReaderT.

classclass (SendOsc m, RecvOsc m) => DuplexOsc (m :: Type -> Type)

Source#

DuplexOsc is the union of SendOsc and RecvOsc.

Instances1DuplexOsc

(Transport t, MonadIO io) => DuplexOsc (ReaderT t io)Defined in hosc-0.21.1 · Sound.Osc.Transport.Monad
DuplexOsc over ReaderT.

classclass (DuplexOsc m, MonadIO m) => Transport (m :: Type -> Type)

Source#

Transport is DuplexOsc with a MonadIO constraint.

Instances1Transport

(Transport t, MonadIO io) => Transport (ReaderT t io)Defined in hosc-0.21.1 · Sound.Osc.Transport.Monad
Transport over ReaderT.

typetype Connection t a = ReaderT t IO a

Source#

Transport connection.

valuewithTransport :: Transport t => IO t -> Connection t r -> IO r

Source#

Bracket Open Sound Control communication.

valuewithTransport_ :: Transport t => IO t -> Connection t r -> IO ()

Source#

void of withTransport.

Send

valuesendMessage :: SendOsc m => Message -> m ()

Source#

Type restricted synonym for sendOsc.

valuesendBundle :: SendOsc m => BundleOf Message -> m ()

Source#

Type restricted synonym for sendOsc.

Receive

valuerecvBundle :: RecvOsc m => m (BundleOf Message)

Source#

Variant of recvPacket that runs packet_to_bundle.

valuerecvMessage :: RecvOsc m => m (Maybe Message)

Source#

Variant of recvPacket that runs packet_to_message.

valuerecvMessage_err :: RecvOsc m => m Message

Source#

Erroring variant.

valuerecvMessages :: RecvOsc m => m [Message]

Source#

Variant of recvPacket that runs packetMessages.

Wait

valuewaitUntil :: RecvOsc m => (PacketOf Message -> Bool) -> m (PacketOf Message)

Source#

Wait for a Packet where the supplied predicate is True, discarding intervening packets.

valuewaitFor :: RecvOsc m => (PacketOf Message -> Maybe a) -> m a

Source#

Wait for a Packet where the supplied function does not give Nothing, discarding intervening packets.

valuewaitImmediate :: RecvOsc m => m (PacketOf Message)

Source#

waitUntil packet_is_immediate.

valuewaitMessage :: RecvOsc m => m Message

Source#

waitFor packet_to_message, ie. an incoming Message or immediate mode Bundle with one element.

valuewaitAddress :: RecvOsc m => Address_Pattern -> m (PacketOf Message)

Source#

A waitFor for variant using packet_has_address to match on the Address_Pattern of incoming Packets.

valuewaitReply :: RecvOsc m => Address_Pattern -> m Message

Source#

Variant on waitAddress that returns matching Message.

valuewaitDatum :: RecvOsc m => Address_Pattern -> m [Datum]

Source#

Variant of waitReply that runs messageDatum.