Send message using Django Channels from outside Consumer class

by

Firstly you need your consumer instance to subscribe to a group. 

from asgiref.sync import async_to_sync

class GameConsumer(WebsocketConsumer):
    def connect(self):
        self.accept()
        self.render()
        async_to_sync(self.add_group)('render_updates_group') 
        controller.startTurn()
...

Then if you are outside of your consumer you will need to send a message to that group so that all the consumers that have registered onto the group get the message.

from channels.layers import get_channel_layer
from asgiref.sync import async_to_sync

def sendDeployments(owner, armies):
    type = "renderDeployments"
    message = owner + " has " + str(armies) + " to deploy"
    channel_layer = get_channel_layer()
    async_to_sync(channel_layer.group_send)(
        'render_updates_group',
        {'type': 'render', 'message': message}
    )

However, you also need to remember to remove your consumer from the group when it disconnects.

class GameConsumer(WebsocketConsumer):
    ....

    def disconnect(self, close_code):
         async_to_sync(self.group_name)('render_updates_group')

If you want to limit which open connections get this render message you need to build your group name accordingly.

eg if you are thinking about some online game then maybe you include a MATCH-ID in the group name that is shared by all connections for the same match.

A good reference for this is the channels Layers documentation but do remember when running this in production you will need a messaging layer (normally Redis) set up.

More Related Contents:

  1. Making moves w/ websockets and python / django ( / twisted? )
  2. Type error on Login using the ‘login()’ function
  3. Django MEDIA_URL and MEDIA_ROOT
  4. Render HTML to PDF in Django site
  5. Django Rest Framework File Upload
  6. How can I filter a Django query with a list of values?
  7. Django: add image in an ImageField from image url
  8. how to iterate through dictionary in a dictionary in django template?
  9. Django multi tenancy
  10. Django – How to make a variable available to all templates?
  11. GeoDjango on Windows: “Could not find the GDAL library” / “OSError: [WinError 126] The specified module could not be found”
  12. manage.py runserver
  13. Django 1.8 sending mail using gmail SMTP
  14. Forbidden (403) CSRF verification failed. Request aborted. Even using the {% csrf_token %}
  15. filter foreignkey field in django admin
  16. Is it better to use path() or url() in urls.py for django 2.0?
  17. How do I make an auto increment integer field in Django?
  18. A QuerySet by aggregate field value
  19. How to override the default value of a Model Field from an Abstract Base Class
  20. Django override save for model only in some cases?
  21. ImproperlyConfiguredError about app_name when using namespace in include()
  22. What is your favorite solution for managing database migrations in django? [closed]
  23. How to get Django AutoFields to start at a higher number
  24. can’t pip install mysql-python
  25. How to remove a field from the parent Form in a subclass?
  26. Install mysqlclient for Django Python on Mac OS X Sierra
  27. Remove non-ASCII characters from a string using python / django
  28. How to get more diagnostic output on a “no module named xyz” error?
  29. What’s the correct way to set up Django translation?
  30. Django admin: How to display the field marked as “editable=False” in the model?

Leave a Comment