python-socketio の API リファレンス
python-socketio (miguelgrinberg/python-socketio) の公開 API 50 件 —— クラス 19、関数 1、メソッド 30。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: miguelgrinberg/python-socketio
| 種別 | 件数 |
|---|---|
| クラス | 19 |
| 関数 | 1 |
| メソッド | 30 |
API 一覧
class
src.socketio.asgi.ASGIAppASGI application middleware for Socket.IO.
class
src.socketio.async_client.AsyncClientA Socket.IO client for asyncio.
method
src.socketio.async_client.AsyncClient.disconnect()Disconnect from the server.
method
src.socketio.async_client.AsyncClient.send(data, namespace=None, callback=None)Send a message to the server.
method
src.socketio.async_client.AsyncClient.shutdown()Stop the client.
class
src.socketio.async_manager.AsyncManagerManage a client list for an asyncio server.
method
src.socketio.async_manager.AsyncManager.disconnect(sid, namespace, **kwargs)Disconnect a client.
method
src.socketio.async_manager.AsyncManager.enter_room(sid, namespace, room, eio_sid=None)Add a client to a room.
method
src.socketio.async_manager.AsyncManager.leave_room(sid, namespace, room)Remove a client from a room.
class
src.socketio.async_redis_manager.AsyncRedisManagerRedis based client manager for asyncio servers.
class
src.socketio.async_server.AsyncServerA Socket.IO server for asyncio.
method
src.socketio.async_server.AsyncServer.close_room(room, namespace=None)Close a room.
method
src.socketio.async_server.AsyncServer.disconnect(sid, namespace=None, ignore_queue=False)Disconnect a client.
method
src.socketio.async_server.AsyncServer.enter_room(sid, room, namespace=None)Enter a room.
method
src.socketio.async_server.AsyncServer.leave_room(sid, room, namespace=None)Leave a room.
class
src.socketio.async_simple_client.AsyncSimpleClientA Socket.IO client.
method
src.socketio.base_client.BaseClient.on(event, handler=None, namespace=None)Register an event handler.
func
src.socketio.base_client.signal_handler(sig, frame)SIGINT handler.
method
src.socketio.base_server.BaseServer.on(event, handler=None, namespace=None)Register an event handler.
class
src.socketio.client.ClientA Socket.IO client.
method
src.socketio.client.Client.disconnect()Disconnect from the server.
method
src.socketio.client.Client.shutdown()Stop the client.
class
src.socketio.exceptions.ConnectionRefusedErrorConnection refused exception.
class
src.socketio.kafka_manager.KafkaManagerKafka based client manager.
class
src.socketio.manager.ManagerManage client connections.
method
src.socketio.manager.Manager.enter_room(sid, namespace, room, eio_sid=None)Add a client to a room.
method
src.socketio.manager.Manager.leave_room(sid, namespace, room)Remove a client from a room.
class
src.socketio.middleware.WSGIAppWSGI middleware for Socket.IO.
class
src.socketio.namespace.ClientNamespaceBase class for client-side class-based namespaces.
method
src.socketio.namespace.ClientNamespace.disconnect()Disconnect from the server.
class
src.socketio.namespace.NamespaceBase class for server-side class-based namespaces.
method
src.socketio.namespace.Namespace.close_room(room, namespace=None)Close a room.
method
src.socketio.namespace.Namespace.disconnect(sid, namespace=None)Disconnect a client.
method
src.socketio.namespace.Namespace.enter_room(sid, room, namespace=None)Enter a room.
method
src.socketio.namespace.Namespace.leave_room(sid, room, namespace=None)Leave a room.
class
src.socketio.packet.PacketSocket.IO packet.
method
src.socketio.packet.Packet.decode(encoded_packet)Decode a transmitted package.
method
src.socketio.packet.Packet.encode()Encode the packet for transmission.
class
src.socketio.pubsub_manager.PubSubManagerManage a client list attached to a pub/sub backend.
class
src.socketio.redis_manager.RedisManagerRedis based client manager.
class
src.socketio.server.ServerA Socket.IO server.
method
src.socketio.server.Server.close_room(room, namespace=None)Close a room.
method
src.socketio.server.Server.disconnect(sid, namespace=None, ignore_queue=False)Disconnect a client.
method
src.socketio.server.Server.enter_room(sid, room, namespace=None)Enter a room.
method
src.socketio.server.Server.leave_room(sid, room, namespace=None)Leave a room.
method
src.socketio.server.Server.shutdown()Stop Socket.IO background tasks.
class
src.socketio.simple_client.SimpleClientA Socket.IO client.
method
src.socketio.simple_client.SimpleClient.disconnect()Disconnect from the server.
method
src.socketio.simple_client.SimpleClient.emit(event, data=None)Emit an event to the server.
class
src.socketio.zmq_manager.ZmqManagerzmq based client manager.
この情報について
掲載しているシグネチャは miguelgrinberg/python-socketio の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。