Actiona Wiki

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.
====== 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 ===
<code javascript>
var myObject = new Udp(events);
</code>

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

=== Example ===
<code javascript>
var myObject = new Udp();
</code>
<code javascript>
var myObject = new Udp({
	onConnected: function()
	{
		Console.print("Connected!");
	},
	onDisconnected: function()
	{
		Console.print("Disconnected!");
	}
});
</code>

===== Méthodes =====

==== connect ====
Ouvre une connexion à un "pair".

=== Syntaxe ===
<code javascript>
myObject.connect(hostname, port, openMode);
</code>
<code javascript>
myObject.connect(hostname, port);
</code>

=== Arguments ===
  - hostname - (string) le nom d'hébergement sur lequel se connecter (adresse ip ou dns)
  - port - (integer) le numéro de port
  - 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|onConnected]] ou la méthode [[#waitForConnected|waitForConnected]] .

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

=== Syntaxe ===
<code javascript>
myObject.write(data);
</code>

=== Arguments ===
  - 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 ===
<code javascript>
myObject.writeText(text);
</code>

=== Arguments ===
  - 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 ===
<code javascript>
myObject.disconnect();
</code>
<code javascript>
myObject.disconnect();
</code>

=== 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|onDisconnected]] ou la méthode [[#waitForDisconnected|waitForDisconnected]] .

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

=== Syntaxe ===
<code javascript>
myObject.read();
</code>

=== Renvoie ===
  * (mixed) les données

=== Notes ===
Pour savoir quand les données sont disponibles utilisez l'évènement [[#onReadyRead|onReadyRead]] ou la méthode [[#waitForReadyRead|waitForReadyRead]] .

==== readText ====
Renvoie le texte envoyé au "pair".

=== Syntaxe ===
<code javascript>
myObject.readText(encoding);
</code>
<code javascript>
myObject.readText();
</code>

=== Arguments ===
  - encoding - ([[en:code:core:global#encoding|Encoding]]) l'encodage à utiliser.

=== Renvoie ===
  * (string) le texte

=== Notes ===
Pour savoir quand le texte est disponible utilisez l'évènement [[#onReadyRead|onReadyRead]] ou la méthode [[#waitForReadyRead|waitForReadyRead]] .

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

=== Syntaxe ===
<code javascript>
myObject.waitForConnected(waitTime);
</code>
<code javascript>
myObject.waitForConnected();
</code>

=== Arguments ===
  - 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 ===
<code javascript>
myObject.waitForDisconnected(waitTime);
</code>
<code javascript>
myObject.waitForDisconnected();
</code>

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

=== Renvoie ===
  * (Udp) cet Udp

=== Exceptions ===
  * (DisconnectionError) en attente de l'échec de connexion

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

=== Syntaxe ===
<code javascript>
myObject.waitForReadyRead(waitTime);
</code>
<code javascript>
myObject.waitForReadyRead();
</code>

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

=== Renvoie ===
  * (Udp) cet Udp

=== Exceptions ===
  * (ReadyReadError) en attente de l'échec du "prêt" en écriture.

===== Évènements =====

==== onConnected ====
Appellé quand une connexion est établie.

=== Syntaxe ===
<code javascript>
myObject.onConnected = function() {};
</code>

=== Example ===
<code javascript>
myObject.onConnected = function()
{
	//Event action
};
</code>

==== onDisconnected ====
Appelé quand une connexion est fermée.

=== Syntaxe ===
<code javascript>
myObject.onDisconnected = function() {};
</code>

=== Example ===
<code javascript>
myObject.onDisconnected = function()
{
	//Event action
};
</code>

==== onReadyRead ====
Appelé quand les données sont disponibles et peuvent être lues pas la méthode [[#read|read]] .

=== Syntaxe ===
<code javascript>
myObject.onReadyRead = function() {};
</code>

=== Example ===
<code javascript>
myObject.onReadyRead = function()
{
	//Event action
};
</code>

==== onError ====
Appelé quand une erreur survient.

=== Syntaxe ===
<code javascript>
myObject.onError = function(errorMessage) {};
</code>

=== Arguments ===
  - errorMessage - (string) texte décrivant l'erreur

=== Example ===
<code javascript>
myObject.errorMessage = function(errorMessage)
{
	//Event action
};
</code>

===== Enumerations =====

==== OpenMode ====
Mode d'ouverture UDP.

=== Valeurs ===
  - ReadOnly: socket ouvert en lecture seule
  - WriteOnly: socket ouvert en écriture seule
  - ReadWrite: socket ouvert en lecture et écriture
  - 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:
<code javascript>
myObject.connect("127.0.0.1", 80, Udp.ReadOnly | Udp.Unbuffered);
</code>