Safe Haskell	Safe-Inferred
Language	Haskell2010

Sound.Osc.Packet

Contents

Message
Bundle
Packet
Address Query

Description

Data types for Osc messages, bundles and packets.

Synopsis

type Address_Pattern = String
data Message = Message {
- messageAddress :: !Address_Pattern
- messageDatum :: ![Datum]
}
message :: Address_Pattern -> [Datum] -> Message
messageSignature :: Message -> String
messageDescriptor :: Message -> Ascii
data Bundle = Bundle {
- bundleTime :: !Time
- bundleMessages :: ![Message]
}
bundle :: Time -> [Message] -> Bundle
data Packet
- = Packet_Message {
  - packetMessage :: !Message
  }
- | Packet_Bundle {
  - packetBundle :: !Bundle
  }
p_bundle :: Time -> [Message] -> Packet
p_message :: Address_Pattern -> [Datum] -> Packet
immediately :: Time
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

Message

type Address_Pattern = String Source #

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

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

Constructors

Message
Fields messageAddress :: !Address_Pattern messageDatum :: ![Datum]

Instances

Instances details

Read Message Source #
Instance details Defined in Sound.Osc.Packet Methods readsPrec :: Int -> ReadS Message # readList :: ReadS [Message] # readPrec :: ReadPrec Message # readListPrec :: ReadPrec [Message] #
Show Message Source #
Instance details Defined in Sound.Osc.Packet Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in Sound.Osc.Packet Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #
Ord Message Source #
Instance details 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 Source #

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

messageSignature :: Message -> String Source #

messageDescriptor :: Message -> Ascii Source #

Bundle

data Bundle Source #

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

Instances details

Read Bundle Source #
Instance details Defined in Sound.Osc.Packet Methods readsPrec :: Int -> ReadS Bundle # readList :: ReadS [Bundle] # readPrec :: ReadPrec Bundle # readListPrec :: ReadPrec [Bundle] #
Show Bundle Source #
Instance details Defined in Sound.Osc.Packet Methods showsPrec :: Int -> Bundle -> ShowS # show :: Bundle -> String # showList :: [Bundle] -> ShowS #
Eq Bundle Source #
Instance details Defined in Sound.Osc.Packet Methods (==) :: Bundle -> Bundle -> Bool # (/=) :: Bundle -> Bundle -> Bool #
Ord Bundle Source #	Osc `Bundle`s can be ordered (time ascending).
Instance details 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 Source #

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

Packet

data Packet Source #

An Osc Packet is either a Message or a Bundle.

Constructors

Packet_Message
Fields packetMessage :: !Message
Packet_Bundle
Fields packetBundle :: !Bundle

Instances

Instances details

Read Packet Source #
Instance details Defined in Sound.Osc.Packet Methods readsPrec :: Int -> ReadS Packet # readList :: ReadS [Packet] # readPrec :: ReadPrec Packet # readListPrec :: ReadPrec [Packet] #
Show Packet Source #
Instance details Defined in Sound.Osc.Packet Methods showsPrec :: Int -> Packet -> ShowS # show :: Packet -> String # showList :: [Packet] -> ShowS #
Eq Packet Source #
Instance details Defined in Sound.Osc.Packet Methods (==) :: Packet -> Packet -> Bool # (/=) :: Packet -> Packet -> Bool #