WebSocket : méthode close()

Syntaxe

close()
close(code)
close(code, reason)

Paramètres

code Facultatif

Un entier représentant la valeur de code de fermeture de connexion WebSocket ^(angl.) indiquant une raison de fermeture :

• Si non défini, un code de fermeture pour la connexion est automatiquement attribué : 1000 pour une fermeture normale, ou sinon une autre valeur standard dans la plage 1001-1015 qui indique la raison réelle de la fermeture de la connexion.
• Si défini, la valeur de ce paramètre code remplace l'attribution automatique du code de fermeture pour la connexion et définit à la place un code personnalisé. La valeur doit être un entier : soit 1000, soit un code personnalisé de votre choix dans la plage 3000-4999. Si vous indiquez une valeur pour code, vous devriez également indiquer une valeur pour reason.

reason Facultatif

Une chaîne de caractères fournissant une raison personnalisée de fermeture de connexion WebSocket ^(angl.) (une explication concise et lisible par l'humain de la fermeture). La valeur ne doit pas dépasser 123 octets (encodée en UTF-8).

Note : Comme UTF-8 utilise deux à quatre octets pour encoder tout caractère non ASCII, une valeur reason de 123 caractères contenant des caractères non ASCII dépasserait la limite de 123 octets.

Si vous indiquez une valeur pour reason, vous devriez également indiquer une valeur pour code.

Valeur de retour

Aucun (undefined).

Exceptions

InvalidAccessError DOMException

Levée si code n'est ni un entier égal à 1000, ni un entier dans la plage 3000 — 4999.

SyntaxError DOMException

Levée si la valeur reason encodée en UTF-8 dépasse 123 octets.

Spécifications

Compatibilité des navigateurs

Voir aussi

• RFC 6455 ^(angl.) (la spécification du protocole WebSocket)