chanx
Getting Started
Introduction
Installation
Configuration
Quick Start
User Guide
User Guide
Authentication
Consumers
Routing
Messages System
Testing
WebSocket Playground
Examples
Examples
Complete Example Project
Basic Example
Chat Application Example
API Reference
Generic Module
Messages Module
Routing
Utils Module
Settings Reference
Testing
Development
Contributing
Changelog
chanx
Index
Index
A
|
B
|
C
|
D
|
E
|
G
|
H
|
I
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
action (chanx.messages.base.BaseMessage attribute)
(chanx.messages.outgoing.GroupCompleteMessage attribute)
add_groups() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
asend_channel_event() (chanx.generic.websocket.AsyncJsonWebsocketConsumer class method)
assert_authenticated_status_ok() (chanx.testing.WebsocketCommunicator method)
,
[1]
assert_closed() (chanx.testing.WebsocketCommunicator method)
,
[1]
AsyncJsonWebsocketConsumer (class in chanx.generic.websocket)
auth_communicator (chanx.testing.WebsocketTestCase attribute)
(chanx.testing.WebsocketTestCase property)
auth_method (chanx.generic.authenticator.ChanxWebsocketAuthenticator attribute)
(chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
authentication_classes (chanx.generic.authenticator.ChanxWebsocketAuthenticator attribute)
(chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
AuthenticationMessage (class in chanx.messages.outgoing)
AuthenticationPayload (class in chanx.messages.outgoing)
AuthenticationResult (class in chanx.generic.authenticator)
authenticator_class (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
,
[1]
B
base_url (chanx.utils.websocket.RouteInfo attribute)
BaseChannelEvent (class in chanx.messages.base)
BaseGroupMessage (class in chanx.messages.base)
BaseMessage (class in chanx.messages.base)
build_groups() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
C
chanx.generic
module
chanx.generic.authenticator
module
chanx.generic.websocket
module
chanx.messages
module
chanx.messages.base
module
chanx.messages.incoming
module
chanx.messages.outgoing
module
chanx.routing
module
chanx.testing
module
chanx.utils.asgi
module
chanx.utils.asyncio
module
chanx.utils.logging
module
chanx.utils.websocket
module
ChanxAuthView (class in chanx.generic.authenticator)
ChanxSerializer (class in chanx.generic.authenticator)
ChanxWebsocketAuthenticator (class in chanx.generic.authenticator)
CompleteMessage (class in chanx.messages.outgoing)
connect() (chanx.testing.WebsocketCommunicator method)
,
[1]
create_communicator() (chanx.testing.WebsocketTestCase method)
,
[1]
create_task() (in module chanx.utils.asyncio)
D
data (chanx.generic.authenticator.AuthenticationResult attribute)
(chanx.messages.outgoing.AuthenticationPayload attribute)
delete() (chanx.generic.authenticator.ChanxAuthView method)
disconnect() (chanx.testing.WebsocketCommunicator method)
E
ErrorMessage (class in chanx.messages.outgoing)
G
get() (chanx.generic.authenticator.ChanxAuthView method)
get_response() (chanx.generic.authenticator.ChanxAuthView method)
get_subprotocols() (chanx.testing.WebsocketTestCase method)
,
[1]
get_websocket_application() (in module chanx.utils.asgi)
get_websocket_routes() (in module chanx.utils.websocket)
get_ws_headers() (chanx.testing.WebsocketTestCase method)
,
[1]
GroupCompleteMessage (class in chanx.messages.outgoing)
H
handle_channel_event() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
handler (chanx.messages.base.BaseChannelEvent attribute)
(chanx.utils.websocket.RouteInfo attribute)
I
include() (in module chanx.routing)
is_authenticated (chanx.generic.authenticator.AuthenticationResult attribute)
is_current (chanx.messages.base.BaseGroupMessage attribute)
is_mine (chanx.messages.base.BaseGroupMessage attribute)
L
log_ignored_actions (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
log_received_message (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
log_sent_message (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
logger (in module chanx.utils.logging)
M
module
chanx.generic
chanx.generic.authenticator
chanx.generic.websocket
chanx.messages
chanx.messages.base
chanx.messages.incoming
chanx.messages.outgoing
chanx.routing
chanx.testing
chanx.utils.asgi
chanx.utils.asyncio
chanx.utils.logging
chanx.utils.websocket
O
obj (chanx.generic.authenticator.AuthenticationResult attribute)
P
patch() (chanx.generic.authenticator.ChanxAuthView method)
path (chanx.utils.websocket.RouteInfo attribute)
path() (in module chanx.routing)
path_params (chanx.utils.websocket.RouteInfo attribute)
payload (chanx.messages.base.BaseChannelEvent attribute)
(chanx.messages.base.BaseMessage attribute)
(chanx.messages.outgoing.AuthenticationMessage attribute)
(chanx.messages.outgoing.ErrorMessage attribute)
permission_classes (chanx.generic.authenticator.ChanxWebsocketAuthenticator attribute)
(chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
PingMessage (class in chanx.messages.incoming)
PongMessage (class in chanx.messages.outgoing)
post() (chanx.generic.authenticator.ChanxAuthView method)
post_authentication() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
put() (chanx.generic.authenticator.ChanxAuthView method)
Q
queryset (chanx.generic.authenticator.ChanxWebsocketAuthenticator attribute)
(chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
R
re_path() (in module chanx.routing)
receive_all_json() (chanx.testing.WebsocketCommunicator method)
,
[1]
receive_event() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
receive_json() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
receive_message() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
receive_until_action() (chanx.testing.WebsocketCommunicator method)
,
[1]
RouteInfo (class in chanx.utils.websocket)
router (chanx.testing.WebsocketTestCase attribute)
S
send_authentication_message (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
send_channel_event() (chanx.generic.websocket.AsyncJsonWebsocketConsumer class method)
send_completion (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
send_group_member() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
send_group_message() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
send_json() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
send_message() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
(chanx.testing.WebsocketCommunicator method)
,
[1]
send_message_immediately (chanx.generic.websocket.AsyncJsonWebsocketConsumer attribute)
send_to_groups() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
serializer_class (chanx.generic.authenticator.ChanxAuthView attribute)
setUp() (chanx.testing.WebsocketTestCase method)
status_code (chanx.generic.authenticator.AuthenticationResult attribute)
(chanx.messages.outgoing.AuthenticationPayload attribute)
status_text (chanx.generic.authenticator.AuthenticationResult attribute)
(chanx.messages.outgoing.AuthenticationPayload attribute)
T
tearDown() (chanx.testing.WebsocketTestCase method)
transform_routes() (in module chanx.utils.websocket)
U
user (chanx.generic.authenticator.AuthenticationResult attribute)
W
wait_for_auth() (chanx.testing.WebsocketCommunicator method)
,
[1]
websocket_connect() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
websocket_disconnect() (chanx.generic.websocket.AsyncJsonWebsocketConsumer method)
WebsocketCommunicator (class in chanx.testing)
WebsocketTestCase (class in chanx.testing)
ws_path (chanx.testing.WebsocketTestCase attribute)