Skip to content

customize listener manager #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,14 @@ That's all you need to do. When storage is enabled, events are written to the da

To enable storage selectively by channel, implement a channel manager and override `is_channel_reliable`.

## Listener manager

To customize listener management (add, remove, kick, queue event), set a listener manager class in `settings.py`:

```py
EVENTSTREAM_LISTENERMANAGER_CLASS = 'django_eventstream.views.ListenerManager'
```

## Receiving in the browser

Include client libraries on the frontend:
Expand Down
9 changes: 5 additions & 4 deletions django_eventstream/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ def kick(self, user_id, channel):
listener.wake_threadsafe()


listener_manager = ListenerManager()


def get_listener_manager():
return listener_manager
from .utils import get_class_from_setting
return get_class_from_setting(
"EVENTSTREAM_LISTENERMANAGER_CLASS",
"django_eventstream.views.ListenerManager",
)


async def stream(event_request, listener):
Expand Down