HelpSource/Classes/OSCMessagePatternDispatcher.schelp

   1 CLASS:: OSCMessagePatternDispatcher
   2 summary:: The default pattern matching dispatcher for OSCFunc and OSCdef.
   3 categories:: External Control>OSC>Dispatchers
   4 related:: Classes/OSCFunc, Classes/OSCdef, Classes/AbstractWrappingDispatcher, Classes/AbstractDispatcher, Classes/AbstractMessageMatcher, Classes/OSCMessageDispatcher, Classes/OSCFuncAddrMessageMatcher, Classes/OSCFuncRecvPortMessageMatcher, Classes/OSCFuncBothMessageMatcher, Guides/OSC_communication
   5
   6 DESCRIPTION::
   7 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
   8
   9
  10 CLASSMETHODS::
  11
  12
  13 INSTANCEMETHODS::
  14
  15 METHOD:: value
  16 Attempt to match an incoming OSC message with this dispatcher's responder funcs, and evaluate their functions for all matches found.
  17
  18 argument:: msg
  19 The OSC message as an link::Classes/Array:: in the form code::[OSCAddress, other args]::.
  20
  21 argument:: time
  22 A link::Classes/Float:: indicating the time the incoming message was sent.
  23
  24 argument:: addr
  25 A link::Classes/NetAddr:: indicating the source of the message.
  26
  27 argument:: recvPort
  28 An link::Classes/Integer:: indicating the port on which the message was received.
  29
  30 METHOD:: typeKey
  31 Returns code::'OSC unmatched'::.
  32
  33 returns:: A link::Classes/Symbol::.
  34