An event driven ddp client
Installation
$ pip install python-ddp
Table of Contents
Latest Version 0.1.5
Version 0.1.4
Version 0.1.3
Version 0.1.2
Version 0.1.1
Version 0.1.0
Establish A Connection And Close It
from DDPClient import DDPClient
client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
client.close()
Establish A Connection Without Auto Reconnect
from DDPClient import DDPClient
client = DDPClient('ws://127.0.0.1:3000/websocket', auto_reconnect=False)
client.connect()
Establish A Connection And With Reconnect Different Frequency
from DDPClient import DDPClient
# try to reconnect every second
client = DDPClient('ws://127.0.0.1:3000/websocket', auto_reconnect=True, auto_reconnect_timeout=1)
client.connect()
Call A Remote Function
from DDPClient import DDPClient
def callback_function(data):
print data
client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
client.call('someFunction', [1,2,3], callback_function)
Subscribe and Unsubscribe
from DDPClient import DDPClient
def subscription_callback(data):
print data
client = DDPClient('ws://127.0.0.1:3000/websocket')
client.connect()
sub_id = client.subscribe('posts', subscription_callback)
client.unsubscribe(sub_id)
####DDPClient(url, auto_reconnect=True, auto_reconnect_timeout=0.5, debug=False)
Arguments
url - to connect to ddp server
Keyword Arguments
auto_reconnect - automatic reconnect (default: True) auto_reconnect_timeout - reconnect every X seconds (default: 0.5) debug - print out lots of debug info (default: False)
####call(self, method, params, callback=None)
Call a method on the server
Arguments
method - the remote server method params - an array of commands to send to the method
Keyword Arguments
callback - a callback function containing the return data
####subscribe(self, name, params, callback=None)
Subcribe to add/change/remove events for a collection
Arguments
name - the name of the publication to subscribe params - params to subscribe (parsed as json)
Keyword Arguments
callback - a callback function that gets executed when the subscription has completed
####unsubscribe(self, sub_id)
Unsubscribe from a collection
Arguments
sub_id - the id of the subsciption (returned by subcribe)
When creating an instance of DDPClient
it is capable of emitting a few events with arguments. The documentation below assumes that you've instanciated a client with the following code:
from DDPClient import DDPClient
client = DDPClient('ws://127.0.0.1:3000/websocket')
Register the event to a callback function
def connected(self):
print '* CONNECTED'
client.on('connected', connected)
The connected event callback takes no arguments
Register the event to a callback function
def closed(self, code, reason):
print '* CONNECTION CLOSED {} {}'.format(code, reason)
client.on('socket_closed', closed)
socket_closed
callback takes the following arguments
code - the error code reason - the error message
def reconnected(self):
print '* RECONNECTED'
client.on('reconnected', reconnected)
reconnected
call back takes no arguments
Register the event to a callback function
def failed(collection, data):
print '* FAILED - data: {}'.format(str(data))
client.on('failed', failed)
failed
callback takes the following arguments
data - the error data
Register the event to a callback function
This event is fired if the server and client can not agree on a DDP version to use and is a fatal error
def version_mismatch(versions):
print '* VERSION MISMATCH - versions: {}'.format(str(versions))
client.on('version_mismatch', version_mismatch)
version_mismatch
callback takes the following arguments
versions - the DDP versions attempted
Register the event to a callback function
def added(collection, id, fields):
print '* ADDED {} {}'.format(collection, id)
for key, value in fields.items():
print ' - FIELD {} {}'.format(key, value)
client.on('added', added)
added
callback takes the following arguments
collection - the collection that has been modified id - the collection item id fields - the fields for item
Register the event to a callback function
def changed(self, collection, id, fields, cleared):
print '* CHANGED {} {}'.format(collection, id)
for key, value in fields.items():
print ' - FIELD {} {}'.format(key, value)
for key, value in cleared.items():
print ' - CLEARED {} {}'.format(key, value)
client.on('changed', changed)
changed
callback takes the following arguments
collection - the collection that has been modified id - the collection item id fields - the fields for item cleared - the fields for the item that have been removed
Register the event to a callback function
def removed(collection, id):
print '* REMOVED {} {}'.format(collection, id)
client.on('removed', removed)
removed
callback takes the following arguments
collection - the collection that has been modified id - the collection item id
####All of the callbacks
For reference
client.on('connected', connected)
client.on('socket_closed', closed)
client.on('reconnected', reconnected)
client.on('failed', failed)
client.on('version_mismatch', version_mismatch)
client.on('added', added)
client.on('changed', changed)
client.on('removed', removed)
##Collaborators