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 BundleOf t

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

Read t => Read (BundleOf t)

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)

Defined in Sound.Osc.Packet

Methods

showsPrec :: Int -> BundleOf t -> ShowS

show :: BundleOf t -> String

showList :: [BundleOf t] -> ShowS

Eq t => Eq (BundleOf t)

Defined in Sound.Osc.Packet

Methods

(==) :: BundleOf t -> BundleOf t -> Bool

(/=) :: BundleOf t -> BundleOf t -> Bool

Eq t => Ord (BundleOf t)

Osc BundleOfs can be ordered (time ascending).

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

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

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

Packet

data PacketOf t

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

Constructors

Packet_Message

Fields

• packetMessage :: !Message

Packet_Bundle

Fields

• packetBundle :: !(BundleOf t)

Instances

Read t => Read (PacketOf t)

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)

Defined in Sound.Osc.Packet

Methods

showsPrec :: Int -> PacketOf t -> ShowS

show :: PacketOf t -> String

showList :: [PacketOf t] -> ShowS

Eq t => Eq (PacketOf t)

Defined in Sound.Osc.Packet

Methods

(==) :: PacketOf t -> PacketOf t -> Bool

(/=) :: PacketOf t -> PacketOf t -> Bool

type Packet = PacketOf Message

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

Packet_Bundle of bundle.

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

Packet_Message of message.

immediately :: Time

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

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

packetTime :: PacketOf t -> Time

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

packetMessages :: PacketOf Message -> [Message]

Retrieve the set of Messages from a Packet.

packet_to_bundle :: PacketOf Message -> BundleOf Message

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

packet_to_message :: PacketOf Message -> Maybe Message

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

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

at_packet :: (Message -> a) -> (BundleOf t -> a) -> PacketOf t -> 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 -> BundleOf Message -> Bool

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

packet_has_address :: Address_Pattern -> PacketOf Message -> Bool

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