HelpSource/Classes/AbstractWrappingDispatcher.schelp

   1 CLASS:: AbstractWrappingDispatcher
   2 summary:: A dispatcher which wraps functions to support multiple paramter matching
   3 categories:: OpenSoundControl, MIDI
   4 related:: Classes/AbstractDispatcher, Classes/AbstractMessageMatcher, Classes/OSCMessageDispatcher, Classes/OSCMessagePatternDispatcher, Classes/MIDIMessageDispatcher, Classes/OSCFunc, Classes/OSCdef, Classes/MIDIFunc, Classes/MIDIdef, Classes/AbstractResponderFunc
   5
   6 DESCRIPTION::
   7 AbstractWrappingDispatcher extends AbstractDispatcher to provide the facility to wrap response functions in specialised objects (instances of subclasses of link::Classes/AbstractMessageMatcher:: to efficiently support matching of multiple parameters. Its subclasses link::Classes/OSCMessageDispatcher:: and link::Classes/MIDIMessageDispatcher:: match using a flat dictionary lookup of the 'most significant' parameter, and only attempt to match other parameters if an initial match is found. This approach is faster than others (such as multi-level dictionaries) for most configurations.
   8
   9
  10 CLASSMETHODS::
  11
  12
  13 INSTANCEMETHODS::
  14 private:: init
  15
  16 METHOD:: wrappedFuncs
  17 Get a dictionary of all currently wrapped functions, stored using their owning responder funcs as keys.
  18
  19 returns:: An link::Classes/IdentityDictionary::.
  20
  21 METHOD:: add
  22 Add a responder func to this dispatcher. Subclasses should extend this to do any necessary bookkeeping. Generally this method should add this dispatcher as a dependant of the responder func, so that it can respond to any changes.
  23
  24 argument:: funcProxy
  25 An instance of a subclass of link::Classes/AbstractResponderFunc:: to add.
  26
  27 METHOD:: remove
  28 Remove a responder func from this dispatcher.
  29
  30 argument:: funcProxy
  31 An instance of a subclass of link::Classes/AbstractResponderFunc:: to remove.
  32
  33 METHOD:: updateFuncForFuncProxy
  34 This method is called within link::#-update:: to update any changes to one of this dispatcher's responder funcs' function(s). Users should not call this method directly, but subclasses may need to extend this method to do additional bookkeeping.
  35
  36 argument:: funcProxy
  37 An instance of a subclass of link::Classes/AbstractResponderFunc::.
  38
  39 METHOD:: wrapFunc
  40 Subclasses should override this method to implement wrapping of functions by instances of appropriate subclasses of link::Classes/AbstractMessageMatcher::.
  41
  42 METHOD:: getKeysForFuncProxy
  43 Subclasses should override this to return an Array containing all the keys at which the specified responder func's functions are stored in this dispatchers active dictionary.
  44
  45 argument:: funcProxy
  46 An instance of a subclass of link::Classes/AbstractResponderFunc::.
  47
  48 returns:: An link::Classes/Array::.
  49
  50 METHOD:: update
  51 Subclasses of link::Classes/AbstractResponderFunc:: should call update on their dispatcher whenever their function (or something else significant) changes.
  52
  53 argument:: funcProxy
  54 An instance of a subclass of link::Classes/AbstractResponderFunc::.
  55
  56 argument:: what
  57 A link::Classes/Symbol:: indicating what has changed. Currently the only thing supported is code::\function::.
  58
  59 METHOD:: free
  60 This method removes this dispatcher from its responder func's dependants dictionaries, and deactivates it. Users should only call this method if you are finished with this dispatcher.
  61
  62