rsc3/doc-schelp/HelpSource/Classes/OSCMessagePatternDispatcher.schelp

34 lines
1.5 KiB
Text

CLASS:: OSCMessagePatternDispatcher
summary:: The default pattern matching dispatcher for OSCFunc and OSCdef.
categories:: External Control>OSC>Dispatchers
related:: Classes/OSCFunc, Classes/OSCdef, Classes/AbstractWrappingDispatcher, Classes/AbstractDispatcher, Classes/AbstractMessageMatcher, Classes/OSCMessageDispatcher, Classes/OSCFuncAddrMessageMatcher, Classes/OSCFuncRecvPortMessageMatcher, Classes/OSCFuncBothMessageMatcher, Guides/OSC_communication
DESCRIPTION::
OSCMessageDispatcher dispatches incoming OSC messages to matching functions, using pattern matching to see if regular expressions wildcards in the incoming message's address pattern match one of this dispatcher's OSCFuncs' paths. Normally users should not have to create or message instances of this class directly. For details on OSC pattern matching, see http://opensoundcontrol.org/spec-1_0
CLASSMETHODS::
INSTANCEMETHODS::
METHOD:: value
Attempt to match an incoming OSC message with this dispatcher's responder funcs, and evaluate their functions for all matches found.
argument:: msg
The OSC message as an link::Classes/Array:: in the form code::[OSCAddress, other args]::.
argument:: time
A link::Classes/Float:: indicating the time the incoming message was sent.
argument:: addr
A link::Classes/NetAddr:: indicating the source of the message.
argument:: recvPort
An link::Classes/Integer:: indicating the port on which the message was received.
METHOD:: typeKey
Returns code::'OSC unmatched'::.
returns:: A link::Classes/Symbol::.