Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / OSCFuncBothMessageMatcher.schelp
blob49ecbfbd8beae1924048d017352247555bec1d98
1 CLASS:: OSCFuncBothMessageMatcher
2 summary:: Matches incoming messages to responder funcs based on receive port and sender address
3 categories:: External Control>OSC>Matchers
4 related:: Classes/AbstractMessageMatcher, Classes/OSCFuncAddrMessageMatcher, Classes/OSCFuncRecvPortMessageMatcher, Classes/OSCFuncBothMessageMatcher
6 DESCRIPTION::
7 This is used by link::Classes/OSCMessageDispatcher:: and link::Classes/OSCMessagePatternDispatcher:: to match incoming OSC messages  to instances of link::Classes/OSCFunc:: or link::Classes/OSCdef:: using receive port and sender address. This class is private, and generally users should not need to address instances directly.
10 CLASSMETHODS::
12 METHOD:: new
13 Make a new instance.
15 argument:: addr
16 The link::Classes/NetAddr:: to attempt to match.
18 argument:: recvPort
19 The receive port to attempt to match, in the form of an link::Classes/Integer::.
21 argument:: func
22 The link::Classes/Function:: to evaluate if a match is found.
24 returns:: An OSCFuncBothMessageMatcher.
27 INSTANCEMETHODS::
28 private:: init
30 METHOD:: value
31 Check to see if a message matches, and evaulate func if it does.
33 argument:: msg
34 The OSC message as an link::Classes/Array:: in the form code::[OSCAddress, other args]::.
36 argument:: time
37 A link::Classes/Float:: indicating the time the incoming message was sent.
39 argument:: testAddr
40 A link::Classes/NetAddr:: indicating the source of the message.
42 argument:: testRecvPort
43 An link::Classes/Integer:: indicating the port on which the message was received.