mirror of
https://github.com/django/daphne.git
synced 2025-11-04 09:37:32 +03:00
70 lines
2.2 KiB
Python
70 lines
2.2 KiB
Python
from __future__ import unicode_literals
|
|
from ..routing import route_class
|
|
from ..sessions import channel_session
|
|
from ..auth import channel_session_user
|
|
|
|
|
|
class BaseConsumer(object):
|
|
"""
|
|
Base class-based consumer class. Provides the mechanisms to be a direct
|
|
routing object and a few other things.
|
|
|
|
Class-based consumers should be used with route_class in routing, like so::
|
|
|
|
from channels import route_class
|
|
routing = [
|
|
route_class(JsonWebsocketConsumer, path=r"^/liveblog/(?P<slug>[^/]+)/"),
|
|
]
|
|
"""
|
|
|
|
method_mapping = {}
|
|
channel_session = False
|
|
channel_session_user = False
|
|
|
|
def __init__(self, message, **kwargs):
|
|
"""
|
|
Constructor, called when a new message comes in (the consumer is
|
|
the uninstantiated class, so calling it creates it)
|
|
"""
|
|
self.message = message
|
|
self.kwargs = kwargs
|
|
self.dispatch(message, **kwargs)
|
|
|
|
@classmethod
|
|
def channel_names(cls):
|
|
"""
|
|
Returns a list of channels this consumer will respond to, in our case
|
|
derived from the method_mapping class attribute.
|
|
"""
|
|
return set(cls.method_mapping.keys())
|
|
|
|
@classmethod
|
|
def as_route(cls, attrs=None, **kwargs):
|
|
"""
|
|
Shortcut function to create route with filters (kwargs)
|
|
to direct to a class-based consumer with given class attributes (attrs)
|
|
"""
|
|
_cls = cls
|
|
if attrs:
|
|
assert isinstance(attrs, dict), 'attrs must be a dict'
|
|
_cls = type(cls.__name__, (cls,), attrs)
|
|
return route_class(_cls, **kwargs)
|
|
|
|
def get_handler(self, message, **kwargs):
|
|
"""
|
|
Return handler uses method_mapping to return the right method to call.
|
|
"""
|
|
handler = getattr(self, self.method_mapping[message.channel.name])
|
|
if self.channel_session_user:
|
|
return channel_session_user(handler)
|
|
elif self.channel_session:
|
|
return channel_session(handler)
|
|
else:
|
|
return handler
|
|
|
|
def dispatch(self, message, **kwargs):
|
|
"""
|
|
Call handler with the message and all keyword arguments.
|
|
"""
|
|
return self.get_handler(message, **kwargs)(message, **kwargs)
|