Documentation de l'API

Veuillez consulter les clients et la documentation de l'API pour référence

Avertissement : Utilisez des versions clientes compatibles avec Socket.IO Server v4. Les versions précédentes peuvent ne pas être prises en charge et peuvent ne pas fonctionner correctement

Langue	Site Web
Java	https://github.com/socketio/socket.io-client-java
JavaScript (navigateur, Node.js ou React Native)	- Étapes d'installation - API - Code source
JavaScript (pour les mini-programmes WeChat)	https://github.com/weapp-socketio/weapp.socket.io
C++	https://github.com/socketio/socket.io-client-cpp
Swift	https://github.com/socketio/socket.io-client-swift
Dart	https://github.com/rikulo/socket.io-client-dart
Python	https://github.com/miguelgrinberg/python-socketio
.Net	https://github.com/doghappy/socket.io-client-csharp
Rust	https://github.com/1c3t3a/rust-socketio
Kotlin	https://github.com/icerockdev/moko-socket-io
PHP	https://github.com/ElephantIO/elephant.io
Golang	https://github.com/maldikhan/go.socket.io

Toutes les API côté client peuvent ne pas être disponibles dans l'implémentation serveur, et inversement.

Matrice de compatibilité

API client	Prise en charge Netty‑SocketIO	Client JavaScript	Client Java	Client Python	Client C++	Client Swift	Client Dart/Flutter	Client .NET	Client PHP	Client Go	Remarques
Se connecter	✅ Oui	io(url, opts)	IO.socket(url)	sio.connect(url)	socket.connect()	socket.connect()	socket.connect()	socket.Connect()	client->Connect()	socket.Connect()	Méthode de connexion standard
Se déconnecter	✅ Oui	socket.disconnect()	socket.disconnect()	sio.disconnect()	socket.disconnect()	socket.disconnect()	socket.disconnect()	socket.Disconnect()	client->Disconnect()	socket.Disconnect()	Le client se déconnecte du serveur
Écoute d'événement	✅ Oui	socket.on(event, cb)	socket.on(EVENT, listener)	@sio.on(event)	socket.on(event, cb)	socket.on(event, cb)	socket.on(event, cb)	socket.On(event, cb)	client->On(event, cb)	socket.On(event, cb)	Gestionnaire d'événements standard
Écouteur unique	✅ Oui	socket.once(event, cb)	socket.once(EVENT, listener)	@sio.once(event)	socket.once(event, cb)	socket.once(event, cb)	socket.once(event, cb)	socket.Once(event, cb)	client->Once(event, cb)	socket.Once(event, cb)	Certains clients n'ont pas de once intégré
Supprimer l'écouteur	✅ Oui	socket.off() / socket.removeListener()	socket.off(EVENT)	sio.off(event)	socket.off(event)	socket.off(event)	socket.off(event)	socket.Off(event)	client->Off(event)	socket.Off(event)	La plupart des clients prennent en charge les cycles de suppression d'écouteurs
Émettre un événement	✅ Oui	socket.emit(event, …args)	socket.emit(event, …args)	sio.emit(event, data)	socket.emit(event, data)	socket.emit(event, data)	socket.emit(event, data)	socket.Emit(event, data)	client->Emit(event, data)	socket.Emit(event, data)	Émission standard
Émission avec ack	✅ Oui	socket.emit(event, …, callback) / emitWithAck()	socket.emit(event, …args, AckCallback)	sio.call(event, data) / await sio.emit(event, data, callback)	socket.emit(event, data, cb)	socket.emit(event, data, cb)	socket.emit(event, data, cb)	socket.Emit(event, data, cb)	client->Emit(event, data, cb)	socket.Emit(event, data, cb)	La prise en charge des ack varie
API Namespace	✅ Oui	io(url/ns) / socket.nsp	socket.of("/ns")	sio.connect(url, namespaces=["/ns"])	socket.of("/ns")	socket.of("/ns")	socket.of("/ns")	socket.Of("/ns")	client->Of("/ns")	socket.Of("/ns")	La plupart des clients multi‑namespace prennent en charge
Query / Auth	⚠️ Limité	io(url, { auth, query })	IO.Options.query/setAuth(Map<String,Object>)	sio.connect(url, auth={…})	socket.setAuth(data)	socket.setAuth(data)	socket.setAuth(data)	socket.SetAuth(data)	client->SetAuth(data)	socket.SetAuth(data)	Les paramètres de poignée de main sont transmis
Contrôle de reconnexion	⚠️ Partiel	Géré par les options du client	socket.io().reconnection(true/false)	sio.reconnect() ou géré par sio.connect()	Dépend de la bibliothèque cliente	Dépend de la bibliothèque cliente	Dépend de la bibliothèque cliente	Dépend de la bibliothèque cliente	Dépend de la bibliothèque cliente	Dépend de la bibliothèque cliente	Logique de reconnexion automatique côté client
Émission volatile	⚠️ Limité	socket.volatile.emit()	Uniquement JS / pas de standard dans le client Java	⚠️ Rare / pas standard	Varie	Varie	Varie	Varie	Varie	Varie	Pas implémenté de manière cohérente
Drapeaux de compression	⚠️ Interne	socket.compress()	Non standard	Non standard	Non standard	Varie	Varie	Varie	Varie	Varie	Généralement interne
Middleware client (use())	❌ Non	JS uniquement	❌	❌	❌	❌	❌	❌	❌	❌	L'API Middleware est en grande partie réservée à JS
Internes Engine/Manager	❌ Non	socket.io / Manager	Interne	Interne	Interne	Interne	Interne	Interne	Interne	Interne	Les internes du client ne sont pas reproduits côté serveur