Outils pour utilisateurs

Outils du site


fr:code:data:tcp

Tcp [En cours de Traduction Wismerheal][WSL]

Cet objet vous permet d'établir une connexion à un serveur en TCP.

Fonctions

Tcp

Fonction de construction.

Syntaxe

var myObject = new Tcp(events);

Arguments

  1. events - (object) l'évènement qui peut être appelé
    • onConnected - (onConnected) appelé quand l'objet est connecté au serveur
    • onDisconnected - (onDisconnected) appelé quand l'objet est déconnecté du serveur
    • onReadyRead - (onReadyRead) appelé quand l'objet est prêt à lire les données envoyées par le serveur
    • onBytesWritten - (onBytesWritten) appelé quand l'objet à terminé d'écrire des données sur le serveur
    • onError - (onError) appelé quand une erreur survient

Example

var myObject = new Tcp();
var myObject = new Tcp({
	onConnected: function()
	{
		Console.print("Connected!");
	},
	onDisconnected: function()
	{
		Console.print("Disconnected!");
	}
});

Méthodes

connect

Ourvre une nouvelle connexion à un server.

Syntaxe

myObject.connect(hostname, port, openMode);
myObject.connect(hostname, port);

Arguments

  1. hostname - (string) le nom d'hébergement sur lequel se connecter (adresse ip ou dns)
  2. port - (integer) le numéro de port
  3. openMode - (OpenMode) le mode d'ouverture (défaut: lecture & écriture)

Renvoie

  • (Tcp) ce Tcp

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que la connexion ne s'établisse. Pour savoir quand la connexion est faite utilisez l'évènement onConnected ou la méthode waitForConnected .

write

Écrit des données sur le serveur.

Syntaxe

myObject.write(data);

Arguments

  1. data - (mixed) les données à écrire

Renvoie

  • (Tcp) ce Tcp

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que la connexion ne s'établisse. Pour savoir quand la connexion est faite utilisez l'évènement onBytesWritten ou la méthode waitForBytesWritten.

writeText

Écrit du texte sur le serveur.

Syntaxe

myObject.writeText(text);

Arguments

  1. text - (string) le texte à écrire

Renvoie

  • (Tcp) ce Tcp

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que la connexion ne s'établisse. Pour savoir quand la connexion est faite utilisez l'évènement onBytesWritten ou la méthode waitForBytesWritten.

disconnect

Ferme une connexion avec un serveur.

Syntaxe

myObject.disconnect();
myObject.disconnect();

Renvoie

  • (Tcp) ce Tcp

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que la connexion ne s'établisse. Pour savoir quand la connexion est faite utilisez l'évènementonDisconnected ou la méthode waitForDisconnected .

read

Renvoie les données envoyées par le serveur.

Syntaxe

myObject.read();

Renvoie

  • (mixed) les données

Notes

Pour savoir quand une donnée est disponible utilisez l'évènement onReadyRead ou la méthode waitForReadyRead .

readText

Renvoie le texte envoyé pr le serveur.

Syntaxe

myObject.readText(encoding);
myObject.readText();

Arguments

  1. encoding - (Encoding) l'encodage à utiliser

Renvoie

  • (string) le texte

Notes

Pour savoir quand une donnée est disponible utilisez l'évènement onReadyRead ou la méthode waitForReadyRead .

waitForConnected

Gèle l'exécution jusqu'à ce que la connexion soit établie ou que le temps imparti waitTime soit écoulé.

Syntaxe

myObject.waitForConnected(waitTime);
myObject.waitForConnected();

Arguments

  1. waitTime - (integer) le temps à attendre (en millisecondes, défaut: 30000)

Renvoie

  • (Tcp) ce Tcp

Exceptions

  • (ConnectionError) ne parvient pas à établir la connexion à l'hébergement

waitForDisconnected

Gèle l'exécution jusqu'à ce que la connexion soit fermée ou que le temps imparti soit écoulé.

Syntaxe

myObject.waitForDisconnected(waitTime);
myObject.waitForDisconnected();

Arguments

  1. waitTime - (integer) le temps à attendre (en millisecondes, défaut: 30000)

Renvoie

  • (Tcp) ce Tcp

Exceptions

  • (DisconnectionError) en attente de l'échec de la connexion

waitForReadyRead

Gèle l'exécution jusqu'à ce que la donnée soit accessible ou que le temps imparti soit écoulé.

Syntaxe

myObject.waitForReadyRead(waitTime);
myObject.waitForReadyRead();

Arguments

  1. waitTime - (integer) le temps à attendre (en millisecondes, défaut: 30000)

Returns

  • (Tcp) ce Tcp

Exceptions

  • (ReadyReadError) en attente de l'échec du "prêt" en lecture

waitForBytesWritten

Gèle l'exécution jusqu'à ce que la donnée soit écrite ou que le temps imparti soit écoulé.

Syntaxe

myObject.waitForBytesWritten(waitTime);
myObject.waitForBytesWritten();

Arguments

  1. waitTime - (integer) le temps à attendre (en millisecondes, défaut: 30000)

Returns

  • (Tcp) ce Tcp

Exceptions

  • (BytesWrittenError) en attente de l'échec d'écriture de données

Évènements

onConnected

Appelé quand la connexion est établie.

Syntaxe

myObject.onConnected = function() {};

Example

myObject.onConnected = function()
{
	//Event action
};

onDisconnected

Appelé quand la connexion est fermée.

Syntaxe

myObject.onDisconnected = function() {};

Example

myObject.onDisconnected = function()
{
	//Event action
};

onReadyRead

Appelé quand ue donnée est disponible peut être lue en utilisant la méthoderead .

Syntaxe

myObject.onReadyRead = function() {};

Example

myObject.onReadyRead = function()
{
	//Event action
};

onBytesWritten

Appelé quand une donnée envoyée au serveur a été écrite.

Syntaxe

myObject.onBytesWritten = function(bytes) {};

Arguments

  1. bytes - (integer) le nombre de bytes qui a été écrit

Example

myObject.onBytesWritten = function(bytes)
{
	//Event action
};

onError

Appelé quand une erreur survient.

Syntaxe

myObject.onError = function(errorMessage) {};

Arguments

  1. errorMessage - (string) texte décrivant l'erreur

Example

myObject.errorMessage = function(errorMessage)
{
	//Event action
};

Enumerations

OpenMode

Mode d'Ouverture.

Valeurs

  1. ReadOnly: socket ouvert en lecture seule
  2. WriteOnly: socket ouvert en écriture seule
  3. ReadWrite: socket ouvert en lecture et écriture
  4. Unbuffered: socket ouvert en mode sans tampon

Notes

Ce sont des indicateurs ce qui veut dire que vous pouvez utiliser de multiples valeurs en utilisant l'opérateur | .

Example:

myObject.connect("127.0.0.1", 80, Tcp.ReadOnly | Tcp.Unbuffered);
fr/code/data/tcp.txt · Dernière modification : 2021/02/13 11:23 de 127.0.0.1