Outils pour utilisateurs

Outils du site


fr:code:data:udp

Ceci est une ancienne révision du document !


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) the events that can be called
    • onConnected - (onConnected) called when the object is connected to the peer
    • onDisconnected - (onDisconnected) called when the object is disconnected from the peer
    • onReadyRead - (onReadyRead) called when the object is ready to read data sent from the peer
    • onError - (onError) called when an error has occured

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

  • (Udp) cet Udp

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

  • (Udp) cet Udp

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

  • (Udp) cet Udp

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

  • (Udp) ce Udp

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

  • (mixed) les données

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

  • (string) le texte

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

  • (Udp) cet Udp

Exceptions

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

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) the time to wait (milliseconds, default: 30000)

Returns

  • (Udp) this Udp

Exceptions

  • (DisconnectionError) waiting for disconnection failed

waitForReadyRead

Freezes the execution until data is available or waitTime time elapsed.

Syntax

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

Arguments

  1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

Returns

  • (Udp) this Udp

Exceptions

  • (ReadyReadError) waiting for ready read failed

Events

onConnected

Called when a connection is established.

Syntax

myObject.onConnected = function() {};

Example

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

onDisconnected

Called when a connection is closed.

Syntax

myObject.onDisconnected = function() {};

Example

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

onReadyRead

Called when data is available and can be read using the read method.

Syntax

myObject.onReadyRead = function() {};

Example

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

onError

Called when an error has occurred.

Syntax

myObject.onError = function(errorMessage) {};

Arguments

  1. errorMessage - (string) text describing the error

Example

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

Enumerations

OpenMode

Udp open mode.

Values

  1. ReadOnly: socked opened for reading only
  2. WriteOnly: socked opened for writing only
  3. ReadWrite: socked opened for reading and writing
  4. Unbuffered: socked opened in unbuffered mode

Notes

This is a flag enumeration, that means that you can use multiple values using the | operator. Example:

myObject.connect("127.0.0.1", 80, Udp.ReadOnly | Udp.Unbuffered);
fr/code/data/udp.1332498654.txt.gz · Dernière modification : 2021/02/13 11:23 (modification externe)