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 BundleOf t = Bundle {
- bundleTime :: !Time
- bundleMessages :: ![t]
}
type Bundle = BundleOf Message
bundle :: Time -> [t] -> BundleOf t
data PacketOf t
- = Packet_Message {
  - packetMessage :: !Message
  }
- | Packet_Bundle {
  - packetBundle :: !(BundleOf t)
  }
type Packet = PacketOf Message
p_bundle :: Time -> [t] -> PacketOf t
p_message :: Address_Pattern -> [Datum] -> PacketOf t
immediately :: Time
packetTime :: PacketOf t -> Time
packetMessages :: PacketOf Message -> [Message]
packet_to_bundle :: PacketOf Message -> BundleOf Message
packet_to_message :: PacketOf Message -> Maybe Message
packet_is_immediate :: PacketOf t -> Bool
at_packet :: (Message -> a) -> (BundleOf t -> a) -> PacketOf t -> a
message_has_address :: Address_Pattern -> Message -> Bool
bundle_has_address :: Address_Pattern -> BundleOf Message -> Bool
packet_has_address :: Address_Pattern -> PacketOf Message -> 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 BundleOf t Source #

An Osc bundle, a Time and a sequence of Messages. The type parameter specifies the element type. Ordinarily this is Message, which does not allow recursion.

Constructors

Bundle
Fields bundleTime :: !Time bundleMessages :: ![t]

Instances

Instances details

Read t => Read (BundleOf t) Source #
Instance details Defined in Sound.Osc.Packet Methods readsPrec :: Int -> ReadS (BundleOf t) # readList :: ReadS [BundleOf t] # readPrec :: ReadPrec (BundleOf t) # readListPrec :: ReadPrec [BundleOf t] #
Show t => Show (BundleOf t) Source #
Instance details Defined in Sound.Osc.Packet Methods showsPrec :: Int -> BundleOf t -> ShowS # show :: BundleOf t -> String # showList :: [BundleOf t] -> ShowS #
Eq t => Eq (BundleOf t) Source #
Instance details Defined in Sound.Osc.Packet Methods (==) :: BundleOf t -> BundleOf t -> Bool # (/=) :: BundleOf t -> BundleOf t -> Bool #
Eq t => Ord (BundleOf t) Source #	Osc `BundleOf`s can be ordered (time ascending).
Instance details Defined in Sound.Osc.Packet Methods compare :: BundleOf t -> BundleOf t -> Ordering # (<) :: BundleOf t -> BundleOf t -> Bool # (<=) :: BundleOf t -> BundleOf t -> Bool # (>) :: BundleOf t -> BundleOf t -> Bool # (>=) :: BundleOf t -> BundleOf t -> Bool # max :: BundleOf t -> BundleOf t -> BundleOf t # min :: BundleOf t -> BundleOf t -> BundleOf t #

type Bundle = BundleOf Message Source #

bundle :: Time -> [t] -> BundleOf t Source #

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

Packet

data PacketOf t Source #

An Osc Packet is either a Message or a 'Bundle t'.

Constructors

Packet_Message
Fields packetMessage :: !Message
Packet_Bundle
Fields packetBundle :: !(BundleOf t)

Instances

Instances details

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

type Packet = PacketOf Message Source #

p_bundle :: Time -> [t] -> PacketOf t Source #

Packet_Bundle of bundle.

p_message :: Address_Pattern -> [Datum] -> PacketOf t Source #

Packet_Message of message.

immediately :: Time Source #

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

>>> immediately == (1 / (2 ^ 32))
True

packetTime :: PacketOf t -> Time Source #

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

packetMessages :: PacketOf Message -> [Message] Source #

Retrieve the set of Messages from a Packet.

packet_to_bundle :: PacketOf Message -> BundleOf Message Source #

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

packet_to_message :: PacketOf Message -> Maybe Message Source #

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

packet_is_immediate :: PacketOf t -> Bool Source #

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

at_packet :: (Message -> a) -> (BundleOf t -> a) -> PacketOf t -> a Source #

Variant of either for Packet.

Address Query

message_has_address :: Address_Pattern -> Message -> Bool Source #

Does Message have the specified Address_Pattern.

bundle_has_address :: Address_Pattern -> BundleOf Message -> Bool Source #

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

packet_has_address :: Address_Pattern -> PacketOf Message -> Bool Source #

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