tornadio2.session

Session

tornadio2.session

Active TornadIO2 connection session.

class tornadio2.session.Session(conn, server, request, expiry=None)

Socket.IO session implementation.

Session has some publicly accessible properties:

server

Server association. Server contains io_loop instance, settings, etc.

remote_ip

Remote IP

is_closed

Check if session is closed or not.

Constructor

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

Session constructor.

conn

Default connection class

server

Associated server

handler

Request handler that created new session

expiry

Session expiry

Callbacks

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)

Set active handler for the session

handler

Associate active Tornado handler with the session

Session.remove_handler(handler)

Remove active handler from the session

handler

Handler to remove

Output

Session.send_message(pack)

Send socket.io encoded message

pack

Encoded socket.io message

Session.flush()

Flush message queue if there’s an active connection running

State

Session.close(endpoint=None)

Close session or endpoint connection.

endpoint

If endpoint is passed, will close open endpoint connection. Otherwise will close whole socket.

Session.is_closed

Check if session was closed

Heartbeats

Session.reset_heartbeat()

Reset hearbeat timer

Session.stop_heartbeat()

Stop active heartbeat

Session.delay_heartbeat()

Delay active heartbeat

Session._heartbeat()

Heartbeat callback

Endpoints

Session.connect_endpoint(url)

Connect endpoint from URL.

url

socket.io endpoint URL.

Session.disconnect_endpoint(endpoint)

Disconnect endpoint

endpoint

endpoint name

Messages

Session.raw_message(msg)

Socket.IO message handler.

msg

Raw socket.io message to handle

Connection information

class tornadio2.session.ConnectionInfo(ip, arguments, cookies)

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

get_argument(name)

Return single argument by name

get_cookie(name)

Return single cookie by its name