sockjs.tornado.conn

sockjs.tornado.conn

SockJS connection interface

class sockjs.tornado.conn.SockJSConnection(session)[source]

Callbacks

SockJSConnection.on_open(request)[source]

Default on_open() handler.

Override when you need to do some initialization or request validation. If you return False, connection will be rejected.

You can also throw Tornado HTTPError to close connection.

request
ConnectionInfo object which contains caller IP address, query string parameters and cookies associated with this request (if any).
SockJSConnection.on_message(message)[source]

Default on_message handler. Must be overridden in your application

SockJSConnection.on_close()[source]

Default on_close handler.

Output

SockJSConnection.send(message, binary=False)[source]

Send message to the client.

message
Message to send.
SockJSConnection.broadcast(clients, message)[source]

Broadcast message to the one or more clients. Use this method if you want to send same message to lots of clients, as it contains several optimizations and will work fast than just having loop in your code.

clients
Clients iterable
message
Message to send.

Management

SockJSConnection.close()[source]
SockJSConnection.is_closed[source]

Check if connection was closed