Once Snorky receives all relevant deltas, the next step is to re-send them to the interested clients, if any. This is controlled with dealer classes.
What is a dealer¶
Dealers are classes which track client subscriptions to certain kinds of models.
Dealers also manage the delivery of deltas, by determining which clients are subscribed to the information that they carry.
What is a subscription¶
In Snorky, clients acquire subscriptions to dealers. Each subscription conforms one or more subscription items. Each subscription item specifies a dealer, and a query to that dealer.
For example, a dealer may be called
CommentsByBlogEntry. A subscription may contain one subscription item having
CommentsByBlogEntry as dealer and
15 as query, in order to get notified of new comments in the blog entry with id 15.
The Dealer API¶
The most basic dealer API is the
Dealer class. You can subclass it to make new dealers.
Matches dealer data with subscriptions in order to deliver deltas to clients.
The name of the dealer. If not provided will default to the name of the class.
The name of the model class that is handled by this dealer. Usually specified as an static attribute.
Called everytime a subscription item referring this Dealer is authorized.
Called everytime a subscription is cancelled, once for each subscription item which refers to this Dealer.
Called every time a delta arrives. If the delta is of
updatetype, it’s called twice, once with the old data and another time with the new data.
It must return an iterable set of the subscription items which represent subscriptions to the provided model.
Often your dealer only has to filter models by a certain field which clients subscribe to.
For example, the
CommentsByBlogEntry dealer would receive subscriptions that specify a blog entry id as query, and each time it receives a delta of model
Comment, it would look which blog entry id it is for, and forward it to those clients which subscribed to it.
Snorky comes with a
SimpleDealer class that leverages this pattern.
This dealer uses a key function in order to determine which subscription items match which models.
A subclass must define a function here that for each model returns a value, usually the value of a certain field.
The dealer will forward deltas to those subscriptions whose query equals the value returned by this function.
from snorky.services.datasync.dealers import SimpleDealer class CommentsByBlogEntry(SimpleDealer): name = "CommentsByBlogEntry" # optional model = "Comment" def get_key_for_model(self, model): return model["entryId"]
Sometimes you want the clients to receive all deltas for a certain model class, unfiltered. For this purpose there is the
Dealer that matches all deltas with all subscription items, without filters.
from snorky.services.datasync.dealers import BroadcastDealer class AllTasks(BroadcastDealer): name = "AllTasks" # optional model = "Task"
For cases where clients need to ask for data filtered to complex criteria
FilterDealer provides an advanced dealer which supports complex filter expressions.
The subscription query for this dealer must be a JSON list specifying a filter expression in prefix notation. These are some examples:
['==', 'color', 'blue']
color is ‘blue’.
['<', 'age', 21]
age is less than 21.
['>=', 'age', 21]
age is greater than or equal to 21.
['and', ['==', 'service', 'prosody'], ['>=', 'severity_level', 3]]
service is ‘prosody’ and severity_level is greater than or equal to 3.
['or', ['not', ['==', 'service', 'java']], ['>=', 'severity_level', 3]]
service is not ‘java’ or severity_level is greater than or equal to 3.
['==', 'player.color', 'blue']
player is a dictionary which contains a property
color, and the value of that property is ‘blue’.
from snorky.services.datasync.dealers import BroadcastDealer class FilteredTasks(FilterDealer): name = "FilteredTasks" # optional model = "Task"