Sound.OSC.Transport.FD

An abstract transport layer with implementations for UDP and TCP transport.

Documentation

class Transport t where

Abstract over the underlying transport protocol.

Methods

sendOSC :: OSC o => t -> o -> IO ()

Encode and send an OSC packet.

recvPacket :: t -> IO Packet

Receive and decode an OSC packet.

close :: t -> IO ()

Close an existing connection.

Instances

Transport UDP

Transport TCP

withTransport :: Transport t => IO t -> (t -> IO a) -> IO a

Bracket OSC communication.

Send

sendMessage :: Transport t => t -> Message -> IO ()

Type restricted synonym for sendOSC.

sendBundle :: Transport t => t -> Bundle -> IO ()

Type restricted synonym for sendOSC.

Receive

recvOSC :: (Transport t, OSC o) => t -> IO (Maybe o)

Variant of recvPacket that runs fromPacket.

recvBundle :: Transport t => t -> IO Bundle

Variant of recvPacket that runs packet_to_bundle.

recvMessage :: Transport t => t -> IO (Maybe Message)

Variant of recvPacket that runs packet_to_message.

recvMessages :: Transport t => t -> IO [Message]

Variant of recvPacket that runs packetMessages.

Timeout

recvPacketTimeout :: Transport t => Double -> t -> IO (Maybe Packet)

Variant of recvPacket that implements an n second timeout.

Wait

waitUntil :: Transport t => t -> (Packet -> Bool) -> IO Packet

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

waitFor :: Transport t => t -> (Packet -> Maybe a) -> IO a

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

waitImmediate :: Transport t => t -> IO Packet

waitUntil packet_is_immediate.

waitMessage :: Transport t => t -> IO Message

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

waitAddress :: Transport t => t -> Address_Pattern -> IO Packet

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

waitReply :: Transport t => t -> Address_Pattern -> IO Message

Variant on waitAddress that returns matching Message.

waitDatum :: Transport t => t -> Address_Pattern -> IO [Datum]

Variant of waitReply that runs messageDatum.