| Safe Haskell | Safe |
|---|---|
| Language | Haskell98 |
Sound.OSC.Packet
Description
Data types for OSC messages, bundles and packets.
- type Address_Pattern = String
- data Message = Message {}
- message :: Address_Pattern -> [Datum] -> Message
- data Bundle = Bundle {
- bundleTime :: Time
- bundleMessages :: [Message]
- bundle :: Time -> [Message] -> Bundle
- data Packet
- = Packet_Message { }
- | Packet_Bundle { }
- p_bundle :: Time -> [Message] -> Packet
- p_message :: Address_Pattern -> [Datum] -> Packet
- packetTime :: Packet -> Time
- packetMessages :: Packet -> [Message]
- packet_to_bundle :: Packet -> Bundle
- packet_to_message :: Packet -> Maybe Message
- packet_is_immediate :: Packet -> Bool
- at_packet :: (Message -> a) -> (Bundle -> a) -> Packet -> a
- message_has_address :: Address_Pattern -> Message -> Bool
- bundle_has_address :: Address_Pattern -> Bundle -> Bool
- packet_has_address :: Address_Pattern -> Packet -> Bool
- messagePP :: FP_Precision -> Message -> String
- bundlePP :: FP_Precision -> Bundle -> String
- packetPP :: FP_Precision -> Packet -> String
Message
type Address_Pattern = String #
OSC address pattern. This is strictly an ASCII value, but it is
very common to pattern match on addresses and matching on
ByteString requires OverloadedStrings.
An OSC message.
Constructors
| Message | |
Fields | |
message :: Address_Pattern -> [Datum] -> Message #
Message constructor. It is an error if the Address_Pattern
doesn't conform to the OSC specification.
Bundle
An OSC bundle.
Constructors
| Bundle | |
Fields
| |
Packet
Constructors
| Packet_Message | |
Fields | |
| Packet_Bundle | |
Fields | |
p_message :: Address_Pattern -> [Datum] -> Packet #
packetTime :: Packet -> Time #
The Time of Packet, if the Packet is a Message this is
immediately.
packet_to_bundle :: Packet -> Bundle #
If Packet is a Message add immediately timestamp, else id.
packet_to_message :: Packet -> Maybe Message #
packet_is_immediate :: Packet -> Bool #
Is Packet immediate, ie. a Bundle with timestamp
immediately, or a plain Message.
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.