ChannelsConsumer

Base channels async consumer.

Constructor:

def __init__(self, args: str = (), kwargs: Any = {}) -> None:
  ...

Methods:

• dispatch

  Signature:

  def dispatch(self, message: ChannelsMessage) -> None:
    ...

  Parameters:

  1. message:

     Type

     ChannelsMessage

• channel_listen

  Listen for messages sent to this consumer.

  Utility to listen for channels messages for this consumer inside a resolver (usually inside a subscription).

  Signature:

  def channel_listen(
      self,
      type: str,
      timeout: float | None = None,
      groups: Sequence[str] = (),
  ) -> AsyncGenerator[Any, None]:
    ...

  Parameters:

  1. type:

     The type of the message to wait for.

     Type

     str

  2. timeout:

     An optional timeout to wait for each subsequent message

     Type

     float | None

     Default

     None

  3. groups:

     An optional sequence of groups to receive messages from. When passing this parameter, the groups will be registered using self.channel_layer.group_add at the beggining of the execution and then discarded using self.channel_layer.group_discard at the end of the execution.

     Type

     Sequence[str]

     Default

     ()

• listen_to_channel

  Listen for messages sent to this consumer.

  Utility to listen for channels messages for this consumer inside a resolver (usually inside a subscription).

  Signature:

  def listen_to_channel(
      self,
      type: str,
      timeout: float | None = None,
      groups: Sequence[str] = (),
  ) -> AsyncGenerator[Any, None]:
    ...

  Parameters:

  1. type:

     The type of the message to wait for.

     Type

     str

  2. timeout:

     An optional timeout to wait for each subsequent message

     Type

     float | None

     Default

     None

  3. groups:

     An optional sequence of groups to receive messages from. When passing this parameter, the groups will be registered using self.channel_layer.group_add at the beggining of the execution and then discarded using self.channel_layer.group_discard at the end of the execution.

     Type

     Sequence[str]

     Default

     ()

Attributes:

1. channel_name:

   Type

   str

2. channel_layer:

   Type

   ChannelsLayer | None

3. channel_receive:

   Type

   Callable[[], Awaitable[dict]]

4. listen_queues:

   Type

   DefaultDict[str, WeakSet[asyncio.Queue]]