3 \]c@s^ddlZddlZddlZddlmZddlmZddlmZddlmZGdddejZ dS) N)asyncio_manager) exceptions)packet)servercseZdZdZd<fdd ZddZd=d d Zd>d d Zd?ddZd@ddZ dAddZ dBddZ dCddZ dDddZ dEddZddZdd ZdFd"d#ZdGd$d%Zd&d'Zd(d)Zd*d+Zd,d-Zd.d/Zd0d1Zd2d3Zd4d5Zd6d7Zd8d9Zd:d;ZZS)H AsyncServera A Socket.IO server for asyncio. This class implements a fully compliant Socket.IO web server with support for websocket and long-polling transports, compatible with the asyncio framework on Python 3.5 or newer. :param client_manager: The client manager instance that will manage the client list. When this is omitted, the client list is stored in an in-memory structure, so the use of multiple connected servers is not possible. :param logger: To enable logging set to ``True`` or pass a logger object to use. To disable logging set to ``False``. :param json: An alternative json module to use for encoding and decoding packets. Custom json modules must have ``dumps`` and ``loads`` functions that are compatible with the standard library versions. :param async_handlers: If set to ``True``, event handlers are executed in separate threads. To run handlers synchronously, set to ``False``. The default is ``True``. :param kwargs: Connection parameters for the underlying Engine.IO server. The Engine.IO configuration supports the following settings: :param async_mode: The asynchronous model to use. See the Deployment section in the documentation for a description of the available options. Valid async modes are "aiohttp". If this argument is not given, an async mode is chosen based on the installed packages. :param ping_timeout: The time in seconds that the client waits for the server to respond before disconnecting. :param ping_interval: The interval in seconds at which the client pings the server. :param max_http_buffer_size: The maximum size of a message when using the polling transport. :param allow_upgrades: Whether to allow transport upgrades or not. :param http_compression: Whether to compress packages when using the polling transport. :param compression_threshold: Only compress messages when their byte size is greater than this value. :param cookie: Name of the HTTP cookie that contains the client session id. If set to ``None``, a cookie is not sent to the client. :param cors_allowed_origins: Origin or list of origins that are allowed to connect to this server. Only the same origin is allowed by default. Set this argument to ``'*'`` to allow all origins, or to ``[]`` to disable CORS handling. :param cors_credentials: Whether credentials (cookies, authentication) are allowed in requests to this server. :param monitor_clients: If set to ``True``, a background task will ensure inactive clients are closed. Set to ``False`` to disable the monitoring task (not recommended). The default is ``True``. :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass a logger object to use. To disable logging set to ``False``. NFTc s2|dkrtj}tjf||d||d|dS)NF)client_managerloggerbinaryjsonasync_handlers)rZ AsyncManagersuper__init__)selfrr r r kwargs) __class__B/tmp/pip-build-mqc4i71p/python-socketio/socketio/asyncio_server.pyrEs  zAsyncServer.__init__cCsdS)NTr)rrrris_asyncio_basedMszAsyncServer.is_asyncio_based socket.iocCs|jj||dS)z.Attach the Socket.IO server to an application.N)eioattach)rZappZ socketio_pathrrrrPszAsyncServer.attachc sP|pd}|p|}|jjd||p d||jj|||f|||d|IdHdS)aEmit a custom event to one or more connected clients. :param event: The event name. It can be any string. The event names ``'connect'``, ``'message'`` and ``'disconnect'`` are reserved and should not be used. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The recipient of the message. This can be set to the session ID of a client to address only that client, or to to any custom room created by the application to address all the clients in that room, If this argument is omitted the event is broadcasted to all connected clients. :param room: Alias for the ``to`` parameter. :param skip_sid: The session ID of a client to skip when broadcasting to a room or to all clients. This can be used to prevent a message from being sent to the sender. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param callback: If given, this function will be called to acknowledge the the client has received the message. The arguments that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the clients directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. Note: this method is a coroutine. /zemitting event "%s" to %s [%s]all)roomskip_sidcallbackN)r infomanageremit) reventdatatorr namespacerrrrrrTs%  zAsyncServer.emitc s(|jd||||||d|IdHdS)aSend a message to one or more connected clients. This function emits an event with the name ``'message'``. Use :func:`emit` to issue custom event names. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The recipient of the message. This can be set to the session ID of a client to address only that client, or to to any custom room created by the application to address all the clients in that room, If this argument is omitted the event is broadcasted to all connected clients. :param room: Alias for the ``to`` parameter. :param skip_sid: The session ID of a client to skip when broadcasting to a room or to all clients. This can be used to prevent a message from being sent to the sender. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param callback: If given, this function will be called to acknowledge the the client has received the message. The arguments that will be passed to the function are those provided by the client. Callback functions can only be used when addressing an individual client. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the clients directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. Note: this method is a coroutine. message)r!r"rrr#rN)r$)r)rr!r"rrr#rrrrrsends% zAsyncServer.send<c s|jstd|jjgfdd}|j|f||p:|||d|IdHytjj|IdHWn&tjk rt j t jdYnXt ddkrdSt ddkrƈddSdS)aEmit a custom event to a client and wait for the response. :param event: The event name. It can be any string. The event names ``'connect'``, ``'message'`` and ``'disconnect'`` are reserved and should not be used. :param data: The data to send to the client or clients. Data can be of type ``str``, ``bytes``, ``list`` or ``dict``. If a ``list`` or ``dict``, the data will be serialized as JSON. :param to: The session ID of the recipient client. :param sid: Alias for the ``to`` parameter. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the event is emitted to the default namespace. :param timeout: The waiting timeout. If the timeout is reached before the client acknowledges the event, then a ``TimeoutError`` exception is raised. :param ignore_queue: Only used when a message queue is configured. If set to ``True``, the event is emitted to the client directly, without going through the queue. This is more efficient, but only works when a single server process is used. It is recommended to always leave this parameter with its default value of ``False``. z/Cannot use call() when async_handlers is False.csj|jdS)N)appendset)args) callback_argscallback_eventrrevent_callbacks z(AsyncServer.call..event_callback)r!rr#rNrr) r RuntimeErrorrZ create_eventrasynciowait_forwait TimeoutErrorsix raise_fromrlen) rr r!r"sidr#timeoutrr,r)r*r+rcalls zAsyncServer.callcs0|pd}|jjd|||jj||IdHdS)a<Close a room. This function removes all the clients from the given room. :param room: Room name. :param namespace: The Socket.IO namespace for the event. If this argument is omitted the default namespace is used. Note: this method is a coroutine. rzroom %s is closing [%s]N)r rr close_room)rrr#rrrr8s zAsyncServer.close_roomcs&|pd}|jj|IdH}|j|iS)aReturn the user session for a client. :param sid: The session id of the client. :param namespace: The Socket.IO namespace. If this argument is omitted the default namespace is used. The return value is a dictionary. Modifications made to this dictionary are not guaranteed to be preserved. If you want to modify the user session, use the ``session`` context manager instead. rN)r get_session setdefault)rr5r# eio_sessionrrrr9s zAsyncServer.get_sessioncs&|pd}|jj|IdH}|||<dS)aStore the user session for a client. :param sid: The session id of the client. :param session: The session dictionary. :param namespace: The Socket.IO namespace. If this argument is omitted the default namespace is used. rN)rr9)rr5sessionr#r;rrr save_sessionszAsyncServer.save_sessioncs Gfdddt}|||S)aTReturn the user session for a client with context manager syntax. :param sid: The session id of the client. This is a context manager that returns the user session dictionary for the client. Any changes that are made to this dictionary inside the context manager block are saved back to the session. Example usage:: @eio.on('connect') def on_connect(sid, environ): username = authenticate_user(environ) if not username: return False with eio.session(sid) as session: session['username'] = username @eio.on('message') def on_message(sid, msg): async with eio.session(sid) as session: print('received message from ', session['username']) cs,eZdZddZfddZfddZdS)z5AsyncServer.session.._session_context_managercSs||_||_||_d|_dS)N)rr5r#r<)rrr5r#rrrrsz>AsyncServer.session.._session_context_manager.__init__cs |jj|jdIdH|_|jS)N)r#)rr9r#r<)r)r5rr __aenter__sz@AsyncServer.session.._session_context_manager.__aenter__cs |jj|j|jdIdHdS)N)r#)rr=r<r#)rr))r5rr __aexit__$s z?AsyncServer.session.._session_context_manager.__aexit__N)__name__ __module__ __qualname__rr>r?r)r5rr_session_context_managers rC)object)rr5r#rCr)r5rr<szAsyncServer.sessioncs|pd}|jj||dr|jjd|||jj||d|j|tjtj|dIdH|j d||IdH|jj ||d|dkr|j j |IdHdS)a Disconnect a client. :param sid: Session ID of the client. :param namespace: The Socket.IO namespace to disconnect. If this argument is omitted the default namespace is used. Note: this method is a coroutine. r)r#zDisconnecting %s [%s]N disconnect) r is_connectedr rpre_disconnect _send_packetrPacket DISCONNECT_trigger_eventrEr)rr5r#rrrrE*s zAsyncServer.disconnectcs|jj||IdHS)zHandle an HTTP request from the client. This is the entry point of the Socket.IO application. This function returns the HTTP response body to deliver to the client. Note: this method is a coroutine. N)rhandle_request)rr)rrrrrL>szAsyncServer.handle_requestcOs|jj|f||S)aStart a background task using the appropriate async model. This is a utility function that applications can use to start a background task using the method that is compatible with the selected async mode. :param target: the target function to execute. Must be a coroutine. :param args: arguments to pass to the function. :param kwargs: keyword arguments to pass to the function. The return value is a ``asyncio.Task`` object. Note: this method is a coroutine. )rstart_background_task)rtargetr)rrrrrMHsz!AsyncServer.start_background_taskrcs|jj|IdHS)a<Sleep for the requested amount of time using the appropriate async model. This is a utility function that applications can use to put a task to sleep without having to worry about using the correct call for the selected async mode. Note: this method is a coroutine. N)rsleep)rsecondsrrrrOYs zAsyncServer.sleepc sHt|trt|}n|g}|j|tjtj||g||ddIdHdS)zSend a message to a client.N)r#r!idr ) isinstancetuplelistrHrrIEVENT)rr5r r!r#rQrrr_emit_internales    zAsyncServer._emit_internalcs^|j}t|trBd}xB|D] }|jj|||dIdHd}qWn|jj||ddIdHdS)z$Send a Socket.IO packet to a client.F)r NT)encoderRrTrr%)rr5pktencoded_packetr eprrrrHqs   zAsyncServer._send_packetcsB|pd}|jj|||jr:|j|tjtj|dIdHd}y |jd|||j|IdH}Wn.t j k r}z|j }d}WYdd}~XnX|dkr|jr|jj |||j|tjtj ||dIdH|jj|||js|j|tjtj||dIdH||jkr>|j|=n&|js>|j|tjtj|dIdHdS)z#Handle a client connection request.r)r#NconnectF)r!r#)rr[Zalways_connectrHrrICONNECTrKenvironrConnectionRefusedErrorZ error_argsrGrJrEERROR)rr5r#Z fail_reasonsuccessexcrrr_handle_connect|s4      zAsyncServer._handle_connectcs|pd}|dkr t|jj}n|g}xD|D]<}|dkr,|jj||r,|jd||IdH|jj||q,W|dkr|jj||r|jdd|IdH|jj|ddS)zHandle a client disconnect.rrEN)rTrZget_namespacesrFrKrE)rr5r#Znamespace_listnrrr_handle_disconnects zAsyncServer._handle_disconnectcsz|pd}|jjd|d|||jj||s@|jjd||dS|jr^|j|j|||||n|j|||||IdHdS)z Handle an incoming client event.rz received event "%s" from %s [%s]rz#%s is not connected to namespace %sN)r rrrFwarningr rM_handle_event_internal)rr5r#rQr!rrr _handle_events  zAsyncServer._handle_eventc s~|j|d||f|ddIdH}|dk rz|dkr8  , ( -   (    r) r.rsr2rrrrServerrrrrrs