Index

A

action (chanx.messages.base.BaseMessage attribute) (chanx.messages.outgoing.EventCompleteMessage attribute) (chanx.messages.outgoing.GroupCompleteMessage attribute) action_key (chanx.core.testing.WebsocketCommunicatorMixin attribute) add() (chanx.core.registry.MessageRegistry method) all_log_ignored_actions (chanx.core.websocket.ChanxWebsocketConsumerMixin property) application (chanx.core.testing.WebsocketCommunicatorMixin attribute) as_consumer() (chanx.core.topic.Topic class method) assert_authenticated_status_ok() (chanx.channels.testing.DjangoWebsocketCommunicator method) assert_closed() (chanx.core.testing.WebsocketCommunicatorMixin method) asyncapi_docs() (in module chanx.fast_channels.views) asyncapi_spec_json() (in module chanx.fast_channels.views) asyncapi_spec_yaml() (in module chanx.fast_channels.views) AsyncAPIDocsView (class in chanx.channels.views)

AsyncAPIDocument (class in chanx.asyncapi.type_defs) AsyncAPIGenerator (class in chanx.asyncapi.generator) AsyncAPISchemaView (class in chanx.channels.views) AsyncJsonWebsocketConsumer (class in chanx.channels.websocket) (class in chanx.fast_channels.websocket) auth_communicator (chanx.channels.testing.WebsocketTestCase property) auth_method (chanx.channels.authenticator.DjangoAuthenticator attribute) auth_view_class (chanx.channels.authenticator.DjangoAuthenticator attribute) authenticate() (chanx.channels.authenticator.DjangoAuthenticator method) (chanx.core.authenticator.BaseAuthenticator method) authentication_classes (chanx.channels.authenticator.DjangoAuthenticator attribute) AuthenticationMessage (class in chanx.messages.outgoing) AuthenticationPayload (class in chanx.messages.outgoing) authorize() (chanx.core.topic.Topic method)

B

base_url (chanx.routing.discovery.RouteInfo attribute) BaseAuthenticator (class in chanx.core.authenticator) BaseMessage (class in chanx.messages.base) broadcast() (chanx.core.topic.Topic class method) broadcast_event() (chanx.core.websocket.ChanxWebsocketConsumerMixin class method) broadcast_event_sync() (chanx.core.websocket.ChanxWebsocketConsumerMixin class method)

broadcast_message() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) build_channels() (chanx.asyncapi.generator.AsyncAPIGenerator method) build_message() (chanx.core.registry.MessageRegistry method) build_message_schema() (chanx.core.registry.MessageRegistry method) build_operations() (chanx.asyncapi.generator.AsyncAPIGenerator method) build_output() (chanx.asyncapi.generator.AsyncAPIGenerator method)

C

camelize (chanx.core.config.Config attribute) capture_broadcast_events() (in module chanx.core.testing) CapturedBroadcastEvent (class in chanx.core.testing) channel() (in module chanx.core.decorators) channel_path (chanx.routing.discovery.RouteInfo property) ChannelObject (class in chanx.asyncapi.type_defs) chanx.asyncapi.constants module chanx.asyncapi.generator module chanx.asyncapi.type_defs module chanx.channels module chanx.channels.authenticator module chanx.channels.management.commands.generate_asyncapi_schema module chanx.channels.settings module chanx.channels.testing module chanx.channels.utils.asgi module chanx.channels.views module chanx.channels.websocket module chanx.core.authenticator module chanx.core.config module chanx.core.decorators module chanx.core.registry module chanx.core.testing module chanx.core.topic module

chanx.core.websocket module chanx.fast_channels module chanx.fast_channels.testing module chanx.fast_channels.views module chanx.fast_channels.websocket module chanx.messages module chanx.messages.base module chanx.messages.incoming module chanx.messages.outgoing module chanx.routing.discovery module chanx.routing.patterns module chanx.routing.traversal module chanx.utils.asyncio module chanx.utils.logging module ChanxAuthView (class in chanx.channels.authenticator) ChanxWebsocketConsumerMixin (class in chanx.core.websocket) close() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) close_code (chanx.core.authenticator.BaseAuthenticator property) CompleteMessage (class in chanx.messages.outgoing) Config (class in chanx.core.config) connect() (chanx.core.testing.WebsocketCommunicatorMixin method) consumer (chanx.core.testing.WebsocketCommunicatorMixin attribute) (chanx.routing.discovery.RouteInfo attribute) create_communicator() (chanx.channels.testing.WebsocketTestCase method) create_task() (in module chanx.utils.asyncio) credentials (chanx.core.authenticator.BaseAuthenticator attribute)

D

data (chanx.messages.outgoing.AuthenticationPayload attribute) DEFAULT_ASYNCAPI_TITLE (in module chanx.asyncapi.constants) DEFAULT_ASYNCAPI_VERSION (in module chanx.asyncapi.constants) DEFAULT_SERVER_PROTOCOL (in module chanx.asyncapi.constants) DEFAULT_SERVER_URL (in module chanx.asyncapi.constants)

disconnect() (chanx.core.testing.WebsocketCommunicatorMixin method) discover_routes() (chanx.routing.discovery.RouteDiscovery method) discriminator_field (chanx.core.config.Config attribute) DJANGO_PARAM_PATTERN (in module chanx.routing.patterns) DjangoAuthenticator (class in chanx.channels.authenticator) DjangoWebsocketCommunicator (class in chanx.channels.testing)

E

Envelope (class in chanx.core.envelope) ErrorMessage (class in chanx.messages.outgoing) event (chanx.core.testing.CapturedBroadcastEvent attribute)

event_handler() (in module chanx.core.decorators) EventCompleteMessage (class in chanx.messages.outgoing) extract_path_parameters() (in module chanx.routing.patterns) extract_routes_from_router() (chanx.routing.discovery.RouteDiscovery method)

G

generate() (chanx.asyncapi.generator.AsyncAPIGenerator method) generate_asyncapi_schema() (in module chanx.channels.views) get() (chanx.channels.views.AsyncAPIDocsView method) (chanx.channels.views.AsyncAPISchemaView method) get_channel() (chanx.asyncapi.type_defs.AsyncAPIDocument method) get_channel_layer() (chanx.channels.websocket.AsyncJsonWebsocketConsumer method) (chanx.core.topic.Topic class method) (chanx.fast_channels.websocket.AsyncJsonWebsocketConsumer method) get_channel_messages() (chanx.asyncapi.generator.AsyncAPIGenerator method) get_message() (chanx.asyncapi.type_defs.AsyncAPIDocument method)

get_operation() (chanx.asyncapi.type_defs.AsyncAPIDocument method) get_pattern_string_and_params() (in module chanx.routing.patterns) get_schema() (chanx.asyncapi.type_defs.AsyncAPIDocument method) get_server() (chanx.asyncapi.type_defs.AsyncAPIDocument method) get_subprotocols() (chanx.channels.testing.WebsocketTestCase method) get_websocket_application() (in module chanx.channels.utils.asgi) get_ws_headers() (chanx.channels.testing.WebsocketTestCase method) group_name() (chanx.core.topic.Topic class method) GroupCompleteMessage (class in chanx.messages.outgoing) groups (chanx.core.testing.CapturedBroadcastEvent attribute)

H

handle_channel_event() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_event_handler_error() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_group_message() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_json() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_json_processing_error() (chanx.core.websocket.ChanxWebsocketConsumerMixin method)

handle_message_handler_error() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_result() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_topic_event() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handle_validation_error() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) handler (chanx.routing.discovery.RouteInfo attribute)

I

InfoObject (class in chanx.asyncapi.type_defs)

L

log_ignored_actions (chanx.core.config.Config attribute) log_websocket_message (chanx.core.config.Config attribute)

logger (in module chanx.utils.logging) lookup_field (chanx.channels.authenticator.DjangoAuthenticator attribute) lookup_url_kwarg (chanx.channels.authenticator.DjangoAuthenticator attribute)

M

MessageObject (class in chanx.asyncapi.type_defs) MessageRegistry (class in chanx.core.registry) model_config (chanx.asyncapi.type_defs.AsyncAPIDocument attribute) (chanx.asyncapi.type_defs.ChannelObject attribute) (chanx.asyncapi.type_defs.InfoObject attribute) (chanx.asyncapi.type_defs.MessageObject attribute) (chanx.asyncapi.type_defs.OperationObject attribute) (chanx.asyncapi.type_defs.SchemaObject attribute) (chanx.asyncapi.type_defs.ServerObject attribute) (chanx.core.envelope.Envelope attribute) module chanx.asyncapi.constants chanx.asyncapi.generator chanx.asyncapi.type_defs chanx.channels chanx.channels.authenticator chanx.channels.management.commands.generate_asyncapi_schema chanx.channels.settings chanx.channels.testing chanx.channels.utils.asgi chanx.channels.views chanx.channels.websocket chanx.core.authenticator chanx.core.config chanx.core.decorators chanx.core.registry chanx.core.testing chanx.core.topic chanx.core.websocket chanx.fast_channels chanx.fast_channels.testing chanx.fast_channels.views chanx.fast_channels.websocket chanx.messages chanx.messages.base chanx.messages.incoming chanx.messages.outgoing chanx.routing.discovery chanx.routing.patterns chanx.routing.traversal chanx.utils.asyncio chanx.utils.logging

O

on_subscribe() (chanx.core.topic.Topic method) on_unsubscribe() (chanx.core.topic.Topic method)

OperationObject (class in chanx.asyncapi.type_defs) override_http_methods (chanx.channels.authenticator.DjangoAuthenticator attribute)

P

parse() (chanx.core.topic.Topic class method) path (chanx.routing.discovery.RouteInfo attribute) path_params (chanx.routing.discovery.RouteInfo attribute) payload (chanx.messages.base.BaseMessage attribute) (chanx.messages.outgoing.AuthenticationMessage attribute) (chanx.messages.outgoing.ErrorMessage attribute)

permission_classes (chanx.channels.authenticator.DjangoAuthenticator attribute) PingMessage (class in chanx.messages.incoming) PongMessage (class in chanx.messages.outgoing) post_authentication() (chanx.core.websocket.ChanxWebsocketConsumerMixin method)

Q

queryset (chanx.channels.authenticator.DjangoAuthenticator attribute)

R

receive() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) receive_all_json() (chanx.core.testing.WebsocketCommunicatorMixin method) receive_all_messages() (chanx.core.testing.WebsocketCommunicatorMixin method) receive_event() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) receive_json() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) receive_json_from() (chanx.core.testing.WebsocketCommunicatorMixin method)

receive_message() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) receive_output() (chanx.core.testing.WebsocketCommunicatorMixin method) receive_topic_message() (chanx.core.testing.WebsocketCommunicatorMixin method) REGEX_PARAM_PATTERN (in module chanx.routing.patterns) resolve_all_refs() (chanx.asyncapi.type_defs.AsyncAPIDocument method) RouteDiscovery (class in chanx.routing.discovery) RouteInfo (class in chanx.routing.discovery)

S

SchemaObject (class in chanx.asyncapi.type_defs) send_authentication_message (chanx.core.config.Config attribute) send_completion (chanx.core.config.Config attribute) send_event() (chanx.core.websocket.ChanxWebsocketConsumerMixin class method) send_event_sync() (chanx.core.websocket.ChanxWebsocketConsumerMixin class method) send_json() (chanx.core.topic.Topic method) (chanx.core.websocket.ChanxWebsocketConsumerMixin method) send_json_to() (chanx.core.testing.WebsocketCommunicatorMixin method) send_message() (chanx.core.testing.WebsocketCommunicatorMixin method) (chanx.core.websocket.ChanxWebsocketConsumerMixin method) send_message_immediately (chanx.core.config.Config attribute) send_topic_error() (chanx.core.websocket.ChanxWebsocketConsumerMixin method)

send_topic_json() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) send_topic_message() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) serializer_class (chanx.channels.authenticator.ChanxAuthView attribute) ServerObject (class in chanx.asyncapi.type_defs) setUp() (chanx.channels.testing.WebsocketTestCase method) should_camelize (chanx.core.topic.Topic property) (chanx.core.websocket.ChanxWebsocketConsumerMixin property) should_send_completion (chanx.core.websocket.ChanxWebsocketConsumerMixin property) STARLETTE_PARAM_PATTERN (in module chanx.routing.patterns) status_code (chanx.core.authenticator.BaseAuthenticator attribute) (chanx.messages.outgoing.AuthenticationPayload attribute) status_text (chanx.messages.outgoing.AuthenticationPayload attribute) subscribe() (chanx.core.testing.WebsocketCommunicatorMixin method)

T

tearDown() (chanx.channels.testing.WebsocketTestCase method)

Topic (class in chanx.core.topic) traverse_middleware_stack() (in module chanx.routing.traversal)

U

unsubscribe() (chanx.core.testing.WebsocketCommunicatorMixin method)

url_params (chanx.core.websocket.ChanxWebsocketConsumerMixin property)

W

wait_for_auth() (chanx.channels.testing.DjangoWebsocketCommunicator method) websocket_connect() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) websocket_disconnect() (chanx.core.websocket.ChanxWebsocketConsumerMixin method) WebsocketCommunicator (class in chanx.channels.testing) (class in chanx.fast_channels.testing)

WebsocketCommunicatorMixin (class in chanx.core.testing) WebsocketTestCase (class in chanx.channels.testing) ws_handler() (in module chanx.core.decorators)