Sound.Osc.Packet

Data types for Osc messages, bundles and packets.

Message

type Address_Pattern = String

Osc address pattern. This is strictly an Ascii value, however it is very common to pattern match on addresses and matching on Data.ByteString.Char8 requires OverloadedStrings.

data Message

An Osc message, an Address_Pattern and a sequence of Datum.

Constructors

Message

Fields

• messageAddress :: !Address_Pattern
• messageDatum :: ![Datum]

Instances

Read Message

Defined in Sound.Osc.Packet

Methods

readsPrec :: Int -> ReadS Message

readList :: ReadS [Message]

readPrec :: ReadPrec Message

readListPrec :: ReadPrec [Message]

Show Message

Defined in Sound.Osc.Packet

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Eq Message

Defined in Sound.Osc.Packet

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Ord Message

Defined in Sound.Osc.Packet

Methods

compare :: Message -> Message -> Ordering

(<) :: Message -> Message -> Bool

(<=) :: Message -> Message -> Bool

(>) :: Message -> Message -> Bool

(>=) :: Message -> Message -> Bool

max :: Message -> Message -> Message

min :: Message -> Message -> Message

message :: Address_Pattern -> [Datum] -> Message

Message constructor. It is an error if the Address_Pattern doesn't conform to the Osc specification.

messageSignature :: Message -> String

messageDescriptor :: Message -> Ascii

Bundle

data Bundle

An Osc bundle, a Time and a sequence of Messages. Do not allow recursion, all contents must be messages.

Constructors

Bundle

Fields

• bundleTime :: !Time
• bundleMessages :: ![Message]

Instances

Read Bundle

Defined in Sound.Osc.Packet

Methods

readsPrec :: Int -> ReadS Bundle

readList :: ReadS [Bundle]

readPrec :: ReadPrec Bundle

readListPrec :: ReadPrec [Bundle]

Show Bundle

Defined in Sound.Osc.Packet

Methods

showsPrec :: Int -> Bundle -> ShowS

show :: Bundle -> String

showList :: [Bundle] -> ShowS

Eq Bundle

Defined in Sound.Osc.Packet

Methods

(==) :: Bundle -> Bundle -> Bool

(/=) :: Bundle -> Bundle -> Bool

Ord Bundle

Osc Bundles can be ordered (time ascending).

Defined in Sound.Osc.Packet

Methods

compare :: Bundle -> Bundle -> Ordering

(<) :: Bundle -> Bundle -> Bool

(<=) :: Bundle -> Bundle -> Bool

(>) :: Bundle -> Bundle -> Bool

(>=) :: Bundle -> Bundle -> Bool

max :: Bundle -> Bundle -> Bundle

min :: Bundle -> Bundle -> Bundle

bundle :: Time -> [Message] -> Bundle

Bundle constructor. It is an error if the Message list is empty.

Packet

data Packet

An Osc Packet is either a Message or a Bundle.

Constructors

Packet_Message

Fields

• packetMessage :: !Message

Packet_Bundle

Fields

• packetBundle :: !Bundle

Instances

Read Packet

Defined in Sound.Osc.Packet

Methods

readsPrec :: Int -> ReadS Packet

readList :: ReadS [Packet]

readPrec :: ReadPrec Packet

readListPrec :: ReadPrec [Packet]

Show Packet

Defined in Sound.Osc.Packet

Methods

showsPrec :: Int -> Packet -> ShowS

show :: Packet -> String

showList :: [Packet] -> ShowS

Eq Packet

Defined in Sound.Osc.Packet

Methods

(==) :: Packet -> Packet -> Bool

(/=) :: Packet -> Packet -> Bool

p_bundle :: Time -> [Message] -> Packet

Packet_Bundle of bundle.

p_message :: Address_Pattern -> [Datum] -> Packet

Packet_Message of message.

immediately :: Time

Constant indicating a bundle to be executed immediately. It has the Ntp64 representation of 1.

ntpr_to_ntpi immediately == 1

packetTime :: Packet -> Time

The Time of Packet, if the Packet is a Message this is immediately.

packetMessages :: Packet -> [Message]

Retrieve the set of Messages from a Packet.

packet_to_bundle :: Packet -> Bundle

If Packet is a Message add immediately timestamp, else id.

packet_to_message :: Packet -> Maybe Message

If Packet is a Message or a Bundle with an immediate time tag and with one element, return the Message, else Nothing.

packet_is_immediate :: Packet -> Bool

Is Packet immediate, ie. a Bundle with timestamp immediately, or a plain Message.

at_packet :: (Message -> a) -> (Bundle -> a) -> Packet -> a

Variant of either for Packet.

Address Query

message_has_address :: Address_Pattern -> Message -> Bool

Does Message have the specified Address_Pattern.

bundle_has_address :: Address_Pattern -> Bundle -> Bool

Do any of the Messages at Bundle have the specified Address_Pattern.

packet_has_address :: Address_Pattern -> Packet -> Bool

Does Packet have the specified Address_Pattern, ie. message_has_address or bundle_has_address.