; t>c@s@dZdkZdklZdklZdfdYZdS(s wtMessenger.py author michael branton This script is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this script; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA N(s OSCMessage(s wtConnections wtMessengercBstZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZRS(s\encapsulates basic methods needed to talk to a wireTAP server (http://wiretap.stetson.edu/)cCst|_g|_|idtd|_|id|id|i d|i d|i d|i ddS(sThis is the class constructor. It can be used to create a new wtMessenger object. All default values will be set by this function so it is best to call it when extending from this class. Defaults to UDP, blocking, with server port 4950 and a randomly selected client port.sFalseiiVsUDPssTrueN( s OSCMessagesselfsmessagesmySubscriptionss setConnecteds wtConnectionsconns setClientPorts setServerPorts setProtocols setChannelssetClearOnSends setBlocking(sself((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys__init__s        cGs@|i||i|d|ii|iddSdS(sThis function will open a connection to the specified server and set the default channel. It returns 'True' on success and 'False' otherwise. The server can be an IP Address or host name.isTrueN(sselfs setServersservers setChannelschannelsconnscreates setConnected(sselfsserverschannel((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys serverConnect2s    cCsSx|iD]}|i|q W|idjo|iin|iddS(sThis function will close the connection if it is open. It also unsubscribes from all subscribed channels so that multiple port subscriptions do not linger.ssFalseN(sselfsmySubscriptionsssubs unsubscribesconnscloses setConnected(sselfssub((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pysserverDisconnect>s cGst|djo |i}n |d}|ddjod|}n|ii||ii|i|ii |ii |i djo|i ndS(sThis function will send a message to the connected server. If channel is not explicitly set, then the default channel will be used. This function will prepend "/in/" to the channel unless the explicit "/" is detected" is/s/in/sTrueN( slenschannelsselfschansmessages setAddresssconns setHostPorts serverportssends getBinaryscossclear(sselfschannelschan((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pyssendJs  cGs|it|djo7|i}t|idjo|ii|qn<|d}|ii||idjo|i|n|ddjod|}nd|GH|i|dS(sThis function is a special form of the send function. Set channel to the name of a subscribe channel you wish to receive data from. The specified channel will automatically be prepended with "/subscribe/" so keep this in mind when setting the value. You may use an explicit channel by starting the channel name with "/". If you omit channel (e.g. subscribe() ) the current default channel will be used. iss/s /subscribe/s subscribing N( sselfsclearslenschannelschansmySubscriptionssappends setChannelssend(sselfschannelschan((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys subscribeas    cGsm|it|djo |i}n |d}|ddjod|}nd|GH|i|dS(sThis function is a special form of the send function. Set channel to the name of an unsubscribe channel you wish to stop receiving data from. The channel specified will automatically be prepended with "/unsubscribe/" so keep this in mind when setting the value or use the explicit channel notation (channel starts with a "/"). If you omit channel (e.g. unsubscribe() ), the default channel will be used.is/s /unsubscribe/sunsubscribing N(sselfsclearslenschannelschanssend(sselfschannelschan((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys unsubscribe|s    cGs%x|D]}|ii|qWdS(sVThis function will add a single value or an array of values to the current message.N(sdatasdatumsselfsmessagesappend(sselfsdatasdatum((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pysaddscGs8|id|i||i||iddS(s6This function will create a new channel on the server.sadds /channelsN(sselfsaddschannels descriptionssend(sselfschannels description((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys addChannels    cCs+|id|i||iddS(s4This function will remove a channel from the server.sremoves /channelsN(sselfsaddschannelssend(sselfschannel((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys removeChannels  cCs|iidS(sThis function will clear the current message. This function is automatically called after a send when the clear on send flag is set to true.N(sselfsmessages clearData(sself((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pysclearscCsgd}|idjoF|ii\}}x$ti|D]}|i |q>Wd}n|SdS(sThis function is used to receive data from a wireTAP server. The function will save a wtData object by reference into the received argument whether data was received or not.sFalsesTrueN( srcsselfs isConnectedsconnsreceivesdatasaddresssOSCs decodeOSCsdatumsreceivedsappend(sselfsreceivedsrcsdatumsaddresssdata((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pysreceives cCs ||_|ii|idS(sprivateN(sserversselfsconnssetHost(sselfsserver((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setServers cCs ||_dS(s+This function will set the default channel.N(schannelsself(sselfschannel((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setChannelscCs ||_|ii|idS(s:This function will set the protocol used by serverConnect.N(sprotocolsselfsconns setProtocol(sselfsprotocol((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setProtocols cCs4||_|idjo|ii|indS(s6This function will set the port used by serverConnect.sN(sportsselfs serverportsconns setHostPort(sselfsport((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setServerPorts cCs ||_|ii|idS(sSThis function will set the port used by the messenger object to receive data on.N(sportsselfs clientportsconns setClientPort(sselfsport((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setClientPorts cCs/|djo|iin|iidS(s\This function will set the blocking mode used when receiving data from a wireTAP server. sTrueN(sblocksselfsconnsnonblock(sselfsblock((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setBlockings cCs ||_dS(sThis function will set the clear on send flag. When set to true, the send function will automatically clear the current message after each call. N(sclearsselfscos(sselfsclear((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pyssetClearOnSendscCs ||_dS(sprivateN(sstatesselfs connected(sselfsstate((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys setConnectedscCs |iSdS(s@This function returns 'True' if connected and 'False' otherwise.N(sselfs connected(sself((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys isConnecteds(s__name__s __module__s__doc__s__init__s serverConnectsserverDisconnectssends subscribes unsubscribesadds addChannels removeChannelsclearsreceives setServers setChannels setProtocols setServerPorts setClientPorts setBlockingssetClearOnSends setConnecteds isConnected(((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys wtMessengers*                (s__doc__sOSCs OSCMessages wtConnections wtMessenger(sOSCs OSCMessages wtConnections wtMessenger((s2/home/delire/devel/python/pyKit-OSC/wtMessenger.pys?s