python-socketio API reference

50 public APIs from python-socketio (miguelgrinberg/python-socketio) — 19 classes, 1 functions, 30 methods. Signatures extracted by static analysis of the actual source.

Repository: miguelgrinberg/python-socketio

Kind	Count
Classes	19
Functions	1
Methods	30

API list

classsrc.socketio.asgi.ASGIApp

ASGI application middleware for Socket.IO.

classsrc.socketio.async_client.AsyncClient

A Socket.IO client for asyncio.

methodsrc.socketio.async_client.AsyncClient.disconnect()

Disconnect from the server.

methodsrc.socketio.async_client.AsyncClient.send(data, namespace=None, callback=None)

Send a message to the server.

methodsrc.socketio.async_client.AsyncClient.shutdown()

Stop the client.

classsrc.socketio.async_manager.AsyncManager

Manage a client list for an asyncio server.

methodsrc.socketio.async_manager.AsyncManager.disconnect(sid, namespace, **kwargs)

Disconnect a client.

methodsrc.socketio.async_manager.AsyncManager.enter_room(sid, namespace, room, eio_sid=None)

Add a client to a room.

methodsrc.socketio.async_manager.AsyncManager.leave_room(sid, namespace, room)

Remove a client from a room.

classsrc.socketio.async_redis_manager.AsyncRedisManager

Redis based client manager for asyncio servers.

classsrc.socketio.async_server.AsyncServer

A Socket.IO server for asyncio.

methodsrc.socketio.async_server.AsyncServer.close_room(room, namespace=None)

Close a room.

methodsrc.socketio.async_server.AsyncServer.disconnect(sid, namespace=None, ignore_queue=False)

Disconnect a client.

methodsrc.socketio.async_server.AsyncServer.enter_room(sid, room, namespace=None)

Enter a room.

methodsrc.socketio.async_server.AsyncServer.leave_room(sid, room, namespace=None)

Leave a room.

classsrc.socketio.async_simple_client.AsyncSimpleClient

A Socket.IO client.

methodsrc.socketio.base_client.BaseClient.on(event, handler=None, namespace=None)

funcsrc.socketio.base_client.signal_handler(sig, frame)

SIGINT handler.

methodsrc.socketio.base_server.BaseServer.on(event, handler=None, namespace=None)

classsrc.socketio.client.Client

A Socket.IO client.

methodsrc.socketio.client.Client.disconnect()

Disconnect from the server.

methodsrc.socketio.client.Client.shutdown()

Stop the client.

classsrc.socketio.exceptions.ConnectionRefusedError

Connection refused exception.

classsrc.socketio.kafka_manager.KafkaManager

Kafka based client manager.

classsrc.socketio.manager.Manager

Manage client connections.

methodsrc.socketio.manager.Manager.enter_room(sid, namespace, room, eio_sid=None)

Add a client to a room.

methodsrc.socketio.manager.Manager.leave_room(sid, namespace, room)

Remove a client from a room.

classsrc.socketio.middleware.WSGIApp

WSGI middleware for Socket.IO.

classsrc.socketio.namespace.ClientNamespace

Base class for client-side class-based namespaces.

methodsrc.socketio.namespace.ClientNamespace.disconnect()

Disconnect from the server.

classsrc.socketio.namespace.Namespace

Base class for server-side class-based namespaces.

methodsrc.socketio.namespace.Namespace.close_room(room, namespace=None)

Close a room.

methodsrc.socketio.namespace.Namespace.disconnect(sid, namespace=None)

Disconnect a client.

methodsrc.socketio.namespace.Namespace.enter_room(sid, room, namespace=None)

Enter a room.

methodsrc.socketio.namespace.Namespace.leave_room(sid, room, namespace=None)

Leave a room.

classsrc.socketio.packet.Packet

Socket.IO packet.

methodsrc.socketio.packet.Packet.decode(encoded_packet)

Decode a transmitted package.

methodsrc.socketio.packet.Packet.encode()

Encode the packet for transmission.

classsrc.socketio.pubsub_manager.PubSubManager

Manage a client list attached to a pub/sub backend.

classsrc.socketio.redis_manager.RedisManager

Redis based client manager.

classsrc.socketio.server.Server

A Socket.IO server.

methodsrc.socketio.server.Server.close_room(room, namespace=None)

Close a room.

methodsrc.socketio.server.Server.disconnect(sid, namespace=None, ignore_queue=False)

Disconnect a client.

methodsrc.socketio.server.Server.enter_room(sid, room, namespace=None)

Enter a room.

methodsrc.socketio.server.Server.leave_room(sid, room, namespace=None)

Leave a room.

methodsrc.socketio.server.Server.shutdown()

Stop Socket.IO background tasks.

classsrc.socketio.simple_client.SimpleClient

A Socket.IO client.

methodsrc.socketio.simple_client.SimpleClient.disconnect()

Disconnect from the server.

methodsrc.socketio.simple_client.SimpleClient.emit(event, data=None)

Emit an event to the server.

classsrc.socketio.zmq_manager.ZmqManager

zmq based client manager.

About this data

These signatures were extracted from the public source of miguelgrinberg/python-socketio using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries