Index

A

action (chanx.messages.base.BaseMessage attribute) (chanx.messages.outgoing.EventCompleteMessage attribute) (chanx.messages.outgoing.GroupCompleteMessage attribute) action_key (chanx.testing.WebsocketCommunicator attribute) add() (chanx.core.registry.MessageRegistry method) all_log_ignored_actions (chanx.core.websocket.AsyncJsonWebsocketConsumer property) application (chanx.testing.WebsocketCommunicator attribute) assert_authenticated_status_ok() (chanx.ext.channels.testing.DjangoWebsocketCommunicator method) assert_closed() (chanx.ext.channels.testing.DjangoWebsocketCommunicator method) (chanx.testing.WebsocketCommunicator method) asyncapi_docs() (in module chanx.ext.fast_channels.views) asyncapi_spec_json() (in module chanx.ext.fast_channels.views)

asyncapi_spec_yaml() (in module chanx.ext.fast_channels.views) AsyncAPIDocsView (class in chanx.ext.channels.views) AsyncAPIDocument (class in chanx.asyncapi.type_defs) AsyncAPIGenerator (class in chanx.asyncapi.generator) AsyncAPISchemaView (class in chanx.ext.channels.views) AsyncJsonWebsocketConsumer (class in chanx.core.websocket) auth_communicator (chanx.ext.channels.testing.WebsocketTestCase property) auth_method (chanx.ext.channels.authenticator.DjangoAuthenticator attribute) auth_view_class (chanx.ext.channels.authenticator.DjangoAuthenticator attribute), [1] authenticate() (chanx.core.authenticator.BaseAuthenticator method) authentication_classes (chanx.ext.channels.authenticator.DjangoAuthenticator attribute) AuthenticationMessage (class in chanx.messages.outgoing) AuthenticationPayload (class in chanx.messages.outgoing)

B

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

broadcast_message() (chanx.core.websocket.AsyncJsonWebsocketConsumer 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) 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.core.authenticator module chanx.core.config module chanx.core.decorators module chanx.core.registry module chanx.core.websocket module chanx.ext.channels module chanx.ext.channels.authenticator module chanx.ext.channels.settings module chanx.ext.channels.testing module chanx.ext.channels.utils.asgi module chanx.ext.channels.views module

chanx.ext.fast_channels module chanx.ext.fast_channels.views 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.testing module chanx.utils.asyncio module chanx.utils.logging module ChanxAuthView (class in chanx.ext.channels.authenticator) CompleteMessage (class in chanx.messages.outgoing) Config (class in chanx.core.config) connect() (chanx.ext.channels.testing.DjangoWebsocketCommunicator method) (chanx.testing.WebsocketCommunicator method) consumer (chanx.routing.discovery.RouteInfo attribute) (chanx.testing.WebsocketCommunicator attribute) create_communicator() (chanx.ext.channels.testing.WebsocketTestCase method) create_task() (in module chanx.utils.asyncio)

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.testing.WebsocketCommunicator 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.ext.channels.authenticator) DjangoWebsocketCommunicator (class in chanx.ext.channels.testing)

E

ErrorMessage (class in chanx.messages.outgoing) 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.ext.channels.views) get() (chanx.ext.channels.views.AsyncAPIDocsView method) (chanx.ext.channels.views.AsyncAPISchemaView method) get_channel_messages() (chanx.asyncapi.generator.AsyncAPIGenerator method)

get_pattern_string_and_params() (in module chanx.routing.patterns) get_subprotocols() (chanx.ext.channels.testing.WebsocketTestCase method) get_websocket_application() (in module chanx.ext.channels.utils.asgi) get_ws_headers() (chanx.ext.channels.testing.WebsocketTestCase method) GroupCompleteMessage (class in chanx.messages.outgoing)

H

handle_channel_event() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_event_handler_error() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_group_message() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_json() (chanx.core.websocket.AsyncJsonWebsocketConsumer method)

handle_json_processing_error() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_message_handler_error() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_result() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) handle_validation_error() (chanx.core.websocket.AsyncJsonWebsocketConsumer 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.ext.channels.authenticator.DjangoAuthenticator attribute) lookup_url_kwarg (chanx.ext.channels.authenticator.DjangoAuthenticator attribute)

M

MessageObject (class in chanx.asyncapi.type_defs) MessageObject.Config (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) module chanx.asyncapi.constants chanx.asyncapi.generator chanx.asyncapi.type_defs chanx.core.authenticator chanx.core.config chanx.core.decorators chanx.core.registry chanx.core.websocket chanx.ext.channels chanx.ext.channels.authenticator chanx.ext.channels.settings chanx.ext.channels.testing chanx.ext.channels.utils.asgi chanx.ext.channels.views chanx.ext.fast_channels chanx.ext.fast_channels.views chanx.messages chanx.messages.base chanx.messages.incoming chanx.messages.outgoing chanx.routing.discovery chanx.routing.patterns chanx.routing.traversal chanx.testing chanx.utils.asyncio chanx.utils.logging

O

OperationObject (class in chanx.asyncapi.type_defs)

override_http_methods (chanx.ext.channels.authenticator.DjangoAuthenticator attribute)

P

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.ext.channels.authenticator.DjangoAuthenticator attribute) PingMessage (class in chanx.messages.incoming) PongMessage (class in chanx.messages.outgoing) post_authentication() (chanx.core.websocket.AsyncJsonWebsocketConsumer method)

Q

queryset (chanx.ext.channels.authenticator.DjangoAuthenticator attribute)

R

receive_all_json() (chanx.testing.WebsocketCommunicator method) receive_all_messages() (chanx.testing.WebsocketCommunicator method) receive_event() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) receive_json() (chanx.core.websocket.AsyncJsonWebsocketConsumer method)

receive_message() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) REGEX_PARAM_PATTERN (in module chanx.routing.patterns) RouteDiscovery (class in chanx.routing.discovery) RouteInfo (class in chanx.routing.discovery)

S

SchemaObject (class in chanx.asyncapi.type_defs) SchemaObject.Config (class in chanx.asyncapi.type_defs) send_completion (chanx.core.config.Config attribute) send_event() (chanx.core.websocket.AsyncJsonWebsocketConsumer class method) send_event_sync() (chanx.core.websocket.AsyncJsonWebsocketConsumer class method) send_json() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) send_message() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) (chanx.testing.WebsocketCommunicator method)

send_message_immediately (chanx.core.config.Config attribute) serializer_class (chanx.ext.channels.authenticator.ChanxAuthView attribute) ServerObject (class in chanx.asyncapi.type_defs) setUp() (chanx.ext.channels.testing.WebsocketTestCase method) should_camelize (chanx.core.websocket.AsyncJsonWebsocketConsumer property) should_send_completion (chanx.core.websocket.AsyncJsonWebsocketConsumer property) STARLETTE_PARAM_PATTERN (in module chanx.routing.patterns) status_code (chanx.messages.outgoing.AuthenticationPayload attribute) status_text (chanx.messages.outgoing.AuthenticationPayload attribute)

T

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

traverse_middleware_stack() (in module chanx.routing.traversal)

W

wait_for_auth() (chanx.ext.channels.testing.DjangoWebsocketCommunicator method) websocket_connect() (chanx.core.websocket.AsyncJsonWebsocketConsumer method) websocket_disconnect() (chanx.core.websocket.AsyncJsonWebsocketConsumer method)

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