Table of Contents

Udp [En cours de Traduction Wismerheal][WSL]

cet objet vous permet d'établir une connexion sur un "pair" en UDP.

Fonctions

Udp

Fonction de construction.

Syntaxe

var myObject = new Udp(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 Udp();
var myObject = new Udp({
	onConnected: function()
	{
		Console.print("Connected!");
	},
	onDisconnected: function()
	{
		Console.print("Disconnected!");
	}
});

Méthodes

connect

Ouvre une connexion à un "pair".

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

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

Écritdes données sur le "pair". Writes some data to the peer.

Syntaxe

myObject.write(data);

Arguments

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

Renvoie

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que l'écriture des données ne soient faites. A cause de la nature peu fiable de l'UDP vous n'avez aucun moyen de déterminer si les données sont arrivées ou non.

writeText

Écrit du texte sur le "pair".

Syntaxe

myObject.writeText(text);

Arguments

  1. text - (string) the text to write

REnvoie

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que l'écriture des données ne soient faites. A cause de la nature peu fiable de l'UDP vous n'avez aucun moyen de déterminer si les données sont arrivées ou non.

disconnect

Ferme la connexion avec le "pair".

Syntaxe

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

REnvoie

Notes

Cette méthode est asynchrone, cela signifie que le renvoi s'effectue avant que la connexion soit fermée. Pour savoir si une connexion est fermée utilisez l'évènement onDisconnected ou la méthode waitForDisconnected .

read

Renvoie les données envoyées par le "pair".

Syntaxe

myObject.read();

Renvoie

Notes

Pour savoir quand les données sont disponibles utilisez l'évènement onReadyRead ou la méthode waitForReadyRead .

readText

Renvoie le texte envoyé au "pair".

Syntaxe

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

Arguments

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

Renvoie

Notes

Pour savoir quand le texte 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 impati waitTime soit écoulé.

Syntaxe

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

Arguments

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

Returns

Exceptions

waitForDisconnected

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

Syntaxe

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

Arguments

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

Renvoie

Exceptions

waitForReadyRead

Gèle l'exécution jusqu'à ce que les données soit disponible our que le temps imparti waitTime soit écoulé.

Syntaxe

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

Arguments

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

Renvoie

Exceptions

Évènements

onConnected

Appellé quand une connexion est établie.

Syntaxe

myObject.onConnected = function() {};

Example

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

onDisconnected

Appelé quand une connexion est fermée.

Syntaxe

myObject.onDisconnected = function() {};

Example

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

onReadyRead

Appelé quand les données sont disponibles et peuvent être lues pas la méthode read .

Syntaxe

myObject.onReadyRead = function() {};

Example

myObject.onReadyRead = function()
{
	//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 UDP.

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, Udp.ReadOnly | Udp.Unbuffered);