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

sendPacket :: t -> PacketOf Message -> IO ()

Encode and send an Osc packet.

recvPacket :: t -> IO (PacketOf Message)

Receive and decode an Osc packet.

recvPacketOr :: t -> IO (Either String Packet)

Receive and either decode an Osc packet.

close :: t -> IO ()

Close an existing connection.

Instances

Transport OscSocket

OscSocket is an instance of Transport.

Defined in Sound.Osc.Transport.Fd.Socket

Methods

sendPacket :: OscSocket -> PacketOf Message -> IO ()

recvPacket :: OscSocket -> IO (PacketOf Message)

recvPacketOr :: OscSocket -> IO (Either String Packet)

close :: OscSocket -> IO ()

Transport Tcp

Tcp is an instance of Transport.

Defined in Sound.Osc.Transport.Fd.Tcp

Methods

sendPacket :: Tcp -> PacketOf Message -> IO ()

recvPacket :: Tcp -> IO (PacketOf Message)

recvPacketOr :: Tcp -> IO (Either String Packet)

close :: Tcp -> IO ()

Transport Udp

Udp is an instance of Transport.

Defined in Sound.Osc.Transport.Fd.Udp

Methods

sendPacket :: Udp -> PacketOf Message -> IO ()

recvPacket :: Udp -> IO (PacketOf Message)

recvPacketOr :: Udp -> IO (Either String Packet)

close :: Udp -> IO ()

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

Bracket Osc communication.

Send

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

sendPacket of Packet_Message.

sendBundle :: Transport t => t -> BundleOf Message -> IO ()

sendPacket of Packet_Bundle.

Receive

recvBundle :: Transport t => t -> IO (BundleOf Message)

Variant of recvPacket that runs packet_to_bundle.

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

Variant of recvPacket that runs packet_to_message.

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

Erroring variant.

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

Variant of recvPacket that runs packetMessages.

Wait

waitUntil :: Transport t => t -> (PacketOf Message -> Bool) -> IO (PacketOf Message)

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

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

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

waitImmediate :: Transport t => t -> IO (PacketOf Message)

waitUntil packet_is_immediate.

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

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

waitAddress :: Transport t => t -> Address_Pattern -> IO (PacketOf Message)

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.