Sound.Osc.Transport.Monad

Monad class implementing an Open Sound Control transport.

Documentation

class Monad m => SendOsc m where

Sender monad.

Methods

sendPacket :: PacketOf Message -> m ()

Encode and send an Osc packet.

Instances

(Transport t, MonadIO io) => SendOsc (ReaderT t io)

SendOsc over ReaderT.

Defined in Sound.Osc.Transport.Monad

Methods

sendPacket :: PacketOf Message -> ReaderT t io ()

class Monad m => RecvOsc m where

Receiver monad.

Methods

recvPacket :: m (PacketOf Message)

Receive and decode an Osc packet.

Instances

(Transport t, MonadIO io) => RecvOsc (ReaderT t io)

RecvOsc over ReaderT.

Defined in Sound.Osc.Transport.Monad

Methods

recvPacket :: ReaderT t io (PacketOf Message)

class (SendOsc m, RecvOsc m) => DuplexOsc m

DuplexOsc is the union of SendOsc and RecvOsc.

Instances

(Transport t, MonadIO io) => DuplexOsc (ReaderT t io)

DuplexOsc over ReaderT.

Defined in Sound.Osc.Transport.Monad

class (DuplexOsc m, MonadIO m) => Transport m

Transport is DuplexOsc with a MonadIO constraint.

Instances

(Transport t, MonadIO io) => Transport (ReaderT t io)

Transport over ReaderT.

Defined in Sound.Osc.Transport.Monad

type Connection t a = ReaderT t IO a

Transport connection.

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

Bracket Open Sound Control communication.

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

void of withTransport.

Send

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

Type restricted synonym for sendOsc.

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

Type restricted synonym for sendOsc.

Receive

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

Variant of recvPacket that runs packet_to_bundle.

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

Variant of recvPacket that runs packet_to_message.

recvMessage_err :: RecvOsc m => m Message

Erroring variant.

recvMessages :: RecvOsc m => m [Message]

Variant of recvPacket that runs packetMessages.

Wait

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

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

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

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

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

waitUntil packet_is_immediate.

waitMessage :: RecvOsc m => m Message

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

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

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

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

Variant on waitAddress that returns matching Message.

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

Variant of waitReply that runs messageDatum.