Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.x45dd5372026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · 45dd537 · 2026-10-11

Modulehosc-0.21.1Haskell2010

Sound.Osc.Transport.Fd

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

1 class
14 values

Packagehosc-0.21.1
Exports15
LanguageHaskell2010
LicenceGPL-3.0-only
SourceFd.hs

classclass 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.

Instances3Transport

Transport OscSocketDefined in hosc-0.21.1 · Sound.Osc.Transport.Fd.Socket
OscSocket is an instance of Transport.
Transport TcpDefined in hosc-0.21.1 · Sound.Osc.Transport.Fd.Tcp
Tcp is an instance of Transport.
Transport UdpDefined in hosc-0.21.1 · Sound.Osc.Transport.Fd.Udp
Udp is an instance of Transport.

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

Bracket Osc communication.

Send

2 declarations

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

sendPacket of Packet_Message.

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

sendPacket of Packet_Bundle.

Receive

4 declarations

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

Variant of recvPacket that runs packet_to_bundle.

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

Variant of recvPacket that runs packet_to_message.

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

Erroring variant.

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

Variant of recvPacket that runs packetMessages.

Wait

7 declarations

valuewaitUntil

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

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

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

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

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

waitUntil packet_is_immediate.

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

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

valuewaitAddress :: 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.

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

Variant on waitAddress that returns matching Message.

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

Variant of waitReply that runs messageDatum.