Source code for socketio.server

import sys
import traceback

from socket import error

from gevent.pywsgi import WSGIServer

from socketio.handler import SocketIOHandler
from socketio.policyserver import FlashPolicyServer
from socketio.virtsocket import Socket
from geventwebsocket.handler import WebSocketHandler

__all__ = ['SocketIOServer']

[docs]class SocketIOServer(WSGIServer): """A WSGI Server with a resource that acts like an SocketIO."""
[docs] def __init__(self, *args, **kwargs): """This is just like the standard WSGIServer __init__, except with a few additional ``kwargs``: :param resource: The URL which has to be identified as a request. Defaults to the / URL. :param transports: Optional list of transports to allow. List of strings, each string should be one of handler.SocketIOHandler.handler_types. :param policy_server: Boolean describing whether or not to use the Flash policy server. Default True. :param policy_listener: A tuple containing (host, port) for the policy server. This is optional and used only if policy server is set to true. The default value is :param heartbeat_interval: int The timeout for the server, we should receive a heartbeat from the client within this interval. This should be less than the ``heartbeat_timeout``. :param heartbeat_timeout: int The timeout for the client when it should send a new heartbeat to the server. This value is sent to the client after a successful handshake. :param close_timeout: int The timeout for the client, when it closes the connection it still X amounts of seconds to do re open of the connection. This value is sent to the client after a successful handshake. :param log_file: str The file in which you want the PyWSGI server to write its access log. If not specified, it is sent to `stderr` (with gevent 0.13). """ self.sockets = {} if 'namespace' in kwargs: print("DEPRECATION WARNING: use resource instead of namespace") self.resource = kwargs.pop('namespace', '') else: self.resource = kwargs.pop('resource', '') self.transports = kwargs.pop('transports', None) if kwargs.pop('policy_server', True): try: address = args[0][0] except TypeError: try: address = args[0].address[0] except AttributeError: address = args[0].cfg_addr[0] policylistener = kwargs.pop('policy_listener', (address, 10843)) self.policy_server = FlashPolicyServer(policylistener) else: self.policy_server = None # Extract other config options self.config = { 'heartbeat_timeout': 60, 'close_timeout': 60, 'heartbeat_interval': 25, } for f in ('heartbeat_timeout', 'heartbeat_interval', 'close_timeout'): if f in kwargs: self.config[f] = int(kwargs.pop(f)) if not 'handler_class' in kwargs: kwargs['handler_class'] = SocketIOHandler if not 'ws_handler_class' in kwargs: self.ws_handler_class = WebSocketHandler else: self.ws_handler_class = kwargs.pop('ws_handler_class') log_file = kwargs.pop('log_file', None) if log_file: kwargs['log'] = open(log_file, 'a') super(SocketIOServer, self).__init__(*args, **kwargs)
[docs] def start_accepting(self): if self.policy_server is not None: try: if not self.policy_server.started: self.policy_server.start() except error, ex: sys.stderr.write( 'FAILED to start flash policy server: %s\n' % (ex, )) except Exception: traceback.print_exc() sys.stderr.write('FAILED to start flash policy server.\n\n') super(SocketIOServer, self).start_accepting()
[docs] def stop(self, timeout=None): if self.policy_server is not None: self.policy_server.stop() super(SocketIOServer, self).stop(timeout=timeout)
[docs] def handle(self, socket, address): # Pass in the config about timeouts, heartbeats, also... handler = self.handler_class(self.config, socket, address, self) handler.handle()
[docs] def get_socket(self, sessid=''): """Return an existing or new client Socket.""" socket = self.sockets.get(sessid) if sessid and not socket: return None # you ask for a session that doesn't exist! if socket is None: socket = Socket(self, self.config) self.sockets[socket.sessid] = socket else: socket.incr_hits() return socket
def serve(app, **kw): _quiet = kw.pop('_quiet', False) _resource = kw.pop('resource', '') if not _quiet: # pragma: no cover # idempotent if logging has already been set up import logging logging.basicConfig() host = kw.pop('host', '') port = int(kw.pop('port', 6543)) transports = kw.pop('transports', None) if transports: transports = [x.strip() for x in transports.split(',')] policy_server = kw.pop('policy_server', False) if policy_server in (True, 'True', 'true', 'enable', 'yes', 'on', '1'): policy_server = True policy_listener_host = kw.pop('policy_listener_host', host) policy_listener_port = int(kw.pop('policy_listener_port', 10843)) kw['policy_listener'] = (policy_listener_host, policy_listener_port) else: policy_server = False server = SocketIOServer((host, port), app, resource=_resource, transports=transports, policy_server=policy_server, **kw) if not _quiet: print('serving on http://%s:%s' % (host, port)) server.serve_forever() def serve_paste(app, global_conf, **kw): """pserve / paster serve / waitress replacement / integration You can pass as parameters: transports = websockets, xhr-multipart, xhr-longpolling, etc... policy_server = True """ serve(app, **kw) return 0