hosc-0.21: Haskell Open Sound Control

Safe Haskell	Safe-Inferred
Language	Haskell2010

Sound.Osc.Transport.Fd

Contents

Send
Receive
Wait

Description

An abstract transport layer with implementations for Udp and Tcp transport.

Synopsis

class Transport t where
- sendPacket :: t -> PacketOf Message -> IO ()
- recvPacket :: t -> IO (PacketOf Message)
- recvPacketOr :: t -> IO (Either String Packet)
- close :: t -> IO ()
withTransport :: Transport t => IO t -> (t -> IO a) -> IO a
sendMessage :: Transport t => t -> Message -> IO ()
sendBundle :: Transport t => t -> BundleOf Message -> IO ()
recvBundle :: Transport t => t -> IO (BundleOf Message)
recvMessage :: Transport t => t -> IO (Maybe Message)
recvMessage_err :: Transport t => t -> IO Message
recvMessages :: Transport t => t -> IO [Message]
waitUntil :: Transport t => t -> (PacketOf Message -> Bool) -> IO (PacketOf Message)
waitFor :: Transport t => t -> (PacketOf Message -> Maybe a) -> IO a
waitImmediate :: Transport t => t -> IO (PacketOf Message)
waitMessage :: Transport t => t -> IO Message
waitAddress :: Transport t => t -> Address_Pattern -> IO (PacketOf Message)
waitReply :: Transport t => t -> Address_Pattern -> IO Message
waitDatum :: Transport t => t -> Address_Pattern -> IO [Datum]

Documentation

class Transport t where Source #

Abstract over the underlying transport protocol.

Methods

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

Encode and send an Osc packet.

recvPacket :: t -> IO (PacketOf Message) Source #

Receive and decode an Osc packet.

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

Receive and either decode an Osc packet.

close :: t -> IO () Source #

Close an existing connection.

Instances

Instances details

Transport OscSocket Source #	`OscSocket` is an instance of `Transport`.
Instance details Defined in Sound.Osc.Transport.Fd.Socket Methods sendPacket :: OscSocket -> PacketOf Message -> IO () Source # recvPacket :: OscSocket -> IO (PacketOf Message) Source # recvPacketOr :: OscSocket -> IO (Either String Packet) Source # close :: OscSocket -> IO () Source #
Transport Tcp Source #	`Tcp` is an instance of `Transport`.
Instance details Defined in Sound.Osc.Transport.Fd.Tcp Methods sendPacket :: Tcp -> PacketOf Message -> IO () Source # recvPacket :: Tcp -> IO (PacketOf Message) Source # recvPacketOr :: Tcp -> IO (Either String Packet) Source # close :: Tcp -> IO () Source #
Transport Udp Source #	`Udp` is an instance of `Transport`.
Instance details Defined in Sound.Osc.Transport.Fd.Udp Methods sendPacket :: Udp -> PacketOf Message -> IO () Source # recvPacket :: Udp -> IO (PacketOf Message) Source # recvPacketOr :: Udp -> IO (Either String Packet) Source # close :: Udp -> IO () Source #

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

Bracket Osc communication.

Send

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

sendPacket of Packet_Message.

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

sendPacket of Packet_Bundle.

Receive

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

Variant of recvPacket that runs packet_to_bundle.

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

Variant of recvPacket that runs packet_to_message.

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

Erroring variant.

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

Variant of recvPacket that runs packetMessages.

Wait

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

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

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

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

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

waitUntil packet_is_immediate.

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

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

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

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 Source #

Variant on waitAddress that returns matching Message.

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

Variant of waitReply that runs messageDatum.