sockjs.tornado.session

sockjs.tornado.session

SockJS session implementation.

Base Session

class sockjs.tornado.session.BaseSession(conn, server)

Base session implementation class

Constructor

BaseSession.__init__(conn, server)

Base constructor.

conn

Connection class

server

SockJSRouter instance

Handlers

BaseSession.set_handler(handler)

Set transport handler handler

Handler, should derive from the sockjs.tornado.transports.base.BaseTransportMixin.

BaseSession.verify_state()

Verify if session was not yet opened. If it is, open it and call connections on_open

BaseSession.remove_handler(handler)

Remove active handler from the session

handler

Handler to remove

Messaging

BaseSession.send_message(msg, stats=True, binary=False)

Send or queue outgoing message

msg

Message to send

stats

If set to True, will update statistics after operation completes

BaseSession.send_jsonified(msg, stats=True)

Send or queue outgoing message which was json-encoded before. Used by the broadcast method.

msg

JSON-encoded message to send

stats

If set to True, will update statistics after operation completes

BaseSession.broadcast(clients, msg)

Optimized broadcast implementation. Depending on type of the session, will json-encode message once and will call either send_message or send_jsonifed.

clients

Clients iterable

msg

Message to send

State

BaseSession.close(code=3000, message='Go away!')

Close session or endpoint connection.

code

Closing code

message

Close message

BaseSession.delayed_close()

Delayed close - won’t close immediately, but on next ioloop tick.

BaseSession.is_closed

Check if session was closed.

BaseSession.get_close_reason()

Return last close reason tuple.

For example:

if self.session.is_closed:

code, reason = self.session.get_close_reason()

Connection Session

class sockjs.tornado.session.Session(conn, server, session_id, expiry=None)

SockJS session implementation.

Constructor

Session.__init__(conn, server, session_id, expiry=None)

Session constructor.

conn

Default connection class

server

SockJSRouter instance

session_id

Session id

expiry

Session expiry time

Session

Session.on_delete(forced)

Session expiration callback

forced

If session item explicitly deleted, forced will be set to True. If item expired, will be set to False.

Handlers

Session.set_handler(handler, start_heartbeat=True)

Set active handler for the session

handler

Associate active Tornado handler with the session

start_heartbeat

Should session start heartbeat immediately

Session.verify_state()

Verify if session was not yet opened. If it is, open it and call connections on_open

Session.remove_handler(handler)

Detach active handler from the session

handler

Handler to remove

Messaging

Session.send_message(msg, stats=True, binary=False)

Send or queue outgoing message

msg

Message to send

stats

If set to True, will update statistics after operation completes

Session.send_jsonified(msg, stats=True)

Send JSON-encoded message

msg

JSON encoded string to send

stats

If set to True, will update statistics after operation completes

Session.on_messages(msg_list)

Handle incoming messages

msg_list

Message list to process

State

Session.flush()

Flush message queue if there’s an active connection running

Session.close(code=3000, message='Go away!')

Close session.

code

Closing code

message

Closing message

Heartbeats

Session.start_heartbeat()

Reset hearbeat timer

Session.stop_heartbeat()

Stop active heartbeat

Session.delay_heartbeat()

Delay active heartbeat

Session._heartbeat()

Heartbeat callback

Utilities

class sockjs.tornado.session.ConnectionInfo(ip, cookies, arguments, headers, path)

Connection information object.

Will be passed to the on_open handler of your connection class.

Has few properties:

ip

Caller IP address

cookies

Collection of cookies

arguments

Collection of the query string arguments

headers

Collection of explicitly exposed headers from the request including: origin, referer, x-forward-for (and associated headers)

path

Request uri path