Objet DgramSocket
dgram.Socket L'objet est un package qui encapsule la fonction du paquet de données EventEmitter.
L'instance DgramSocket est créée par dgram.createSocket() Créé. créerdgram.Socket L'instance n'a pas besoin d'utiliser le nouveau mot-clé.
Méthode de création :
1
2var dgram = require('dgram');
var sock = dgram.createSocket('udp4');
un événement
DgramSocket hérité de EventEmitter, Le changement d'état de l'objet et l'acceptation des données sont tous réalisés sous forme d'événements.
fermer l'événement
close
Les événements utiliseront close()
pour fermer un socket
déclencheur après. L'événement Une fois déclenché, cela socket
ne déclenchera pas un nouvel message
événement.
événement d'erreur
Lorsqu'une erreur se produit, l' error
événement est déclenché.
événement d'écoute
Lors d'un socket
début d'écoute des informations de paquet, listening
l'événement sera déclenché. Cet événement sera déclenché immédiatement après la création du socket UDP.
événement de message
Lorsqu'un nouveau paquet est socket
reçu, l' message
événement sera déclenché. msg
Et rinfo
transmis au gestionnaire d'événements en tant que paramètre.
- msg: Buffer,informations
- rinfo: Objet, informations d'adresse distante
- address: chaîne, adresse de l'expéditeur
- family: chaîne, type d'adresse ('IPv4' ou 'IPv6')
- port: numéro, port expéditeur
- size: nombre, taille du message
Héritage
Propriétés statiques
defaultMaxListeners
Entier, le nombre maximal global par défaut d'auditeurs
1static Integer DgramSocket.defaultMaxListeners;
Fonction membre
bind
Cette méthode fera dgram.SocketSpécifié port
et addr
écouter les informations sur les paquets. Lorsque la liaison déclenche un listening
événement complet .
1
2DgramSocket.bind(Integer port = 0,
String addr = "") async;
Paramètres d'appel :
- port: Entier, spécifie la liaison de port, s'il
port
n'est pas spécifié ou est égal à zéro, le système tente de lier un port aléatoire - addr: chaîne, spécifiez l'adresse de liaison. Si l'adresse n'est pas spécifiée, le système d'exploitation essaiera d'écouter sur toutes les adresses.
Cette méthode fera dgram.SocketDans opts
spécifié port
et address
écouter sur les informations de paquet. Lorsque la liaison déclenche un listening
événement complet .
1DgramSocket.bind(Object opts) async;
Paramètres d'appel :
- opts: Objet, spécifiez les paramètres de liaison
send
Envoyer un paquet sur la socket
1
2
3Integer DgramSocket.send(Buffer msg,
Integer port,
String address = "") async;
Paramètres d'appel :
- msg: Buffer, Spécifiez les données à envoyer
- port: Entier, spécifiez le port de destination pour l'envoi
- address: chaîne, spécifiez l'adresse de destination pour l'envoi
Résultat de retour :
- Integer, Retourner la taille d'envoi
Envoyer un paquet sur la socket
1
2
3
4
5Integer DgramSocket.send(Buffer msg,
Integer offset,
Integer length,
Integer port,
String address = "") async;
Paramètres d'appel :
- msg: Buffer, Spécifiez les données à envoyer
- offset: Entier, démarre l'envoi à partir de l'offset spécifié
- length: Entier, la durée d'envoi spécifiée
- port: Entier, spécifiez le port de destination pour l'envoi
- address: chaîne, spécifiez l'adresse de destination pour l'envoi
Résultat de retour :
- Integer, Retourner la taille d'envoi
address
Renvoie un objet contenant des informations d'adresse de socket. Pour le socket UDP, cet objet contiendra les attributs d'adresse, de famille et de port.
1NObject DgramSocket.address();
Résultat de retour :
- NObject, Renvoie l'adresse de liaison de l'objet
close
Fermer la prise actuelle
1DgramSocket.close();
Fermer la prise actuelle
1DgramSocket.close(Function callback);
Paramètres d'appel :
- callback: fonction, arrêtée après l'achèvement de la fonction de rappel, ce qui équivaut à
close
ajouter un écouteur d'événement
getRecvBufferSize
Taille du tampon de réception du socket de requête
1Integer DgramSocket.getRecvBufferSize();
Résultat de retour :
- Integer, Renvoyer le résultat de la requête
getSendBufferSize
Interroger la taille du tampon d'envoi de socket
1Integer DgramSocket.getSendBufferSize();
Résultat de retour :
- Integer, Renvoyer le résultat de la requête
setRecvBufferSize
Définir la taille du tampon de réception du socket
1DgramSocket.setRecvBufferSize(Integer size);
Paramètres d'appel :
- size: Entier, spécifiez la taille à définir
setSendBufferSize
Définir la taille du tampon d'envoi du socket
1DgramSocket.setSendBufferSize(Integer size);
Paramètres d'appel :
- size: Entier, spécifiez la taille à définir
setBroadcast
Définissez ou désactivez l'option de socket SO_BROADCAST
1DgramSocket.setBroadcast(Boolean flag);
Paramètres d'appel :
- flag: booléen, lorsqu'il est défini sur true, les paquets UDP seront envoyés à l'adresse de diffusion d'une interface locale
ref
Empêcher le processus fibjs de se terminer et empêcher le processus fibjs de se fermer pendant la liaison d'objet
1DgramSocket DgramSocket.ref();
Résultat de retour :
- DgramSocket, Renvoie l'objet courant
unref
Autoriser la sortie du processus fibjs et autoriser la sortie du processus fibjs pendant la liaison d'objet
1DgramSocket DgramSocket.unref();
Résultat de retour :
- DgramSocket, Renvoie l'objet courant
on
Lier un gestionnaire d'événements à l'objet
1
2Object DgramSocket.on(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Lier un gestionnaire d'événements à l'objet
1Object DgramSocket.on(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
addListener
Lier un gestionnaire d'événements à l'objet
1
2Object DgramSocket.addListener(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Lier un gestionnaire d'événements à l'objet
1Object DgramSocket.addListener(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
prependListener
Lier un gestionnaire d'événement au début de l'objet
1
2Object DgramSocket.prependListener(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Lier un gestionnaire d'événement au début de l'objet
1Object DgramSocket.prependListener(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
once
Liez une fonction de traitement d'événement unique à l'objet, la fonction de traitement unique ne sera déclenchée qu'une seule fois
1
2Object DgramSocket.once(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Liez une fonction de traitement d'événement unique à l'objet, la fonction de traitement unique ne sera déclenchée qu'une seule fois
1Object DgramSocket.once(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
prependOnceListener
Lier un gestionnaire d'événement au début de l'objet
1
2Object DgramSocket.prependOnceListener(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Lier un gestionnaire d'événement au début de l'objet
1Object DgramSocket.prependOnceListener(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet sera utilisé comme nom d'événement et la valeur de propriété sera utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
off
Annuler la fonction spécifiée de la file d'attente de traitement d'objet
1
2Object DgramSocket.off(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Annuler toutes les fonctions dans la file d'attente de traitement des objets
1Object DgramSocket.off(String ev);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Annuler la fonction spécifiée de la file d'attente de traitement d'objet
1Object DgramSocket.off(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet est utilisé comme nom d'événement et la valeur de propriété est utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
removeListener
Annuler la fonction spécifiée de la file d'attente de traitement d'objet
1
2Object DgramSocket.removeListener(String ev,
Function func);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
- func: fonction, spécifiez la fonction de traitement des événements
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Annuler toutes les fonctions dans la file d'attente de traitement des objets
1Object DgramSocket.removeListener(String ev);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Annuler la fonction spécifiée de la file d'attente de traitement d'objet
1Object DgramSocket.removeListener(Object map);
Paramètres d'appel :
- map: Objet, spécifiez la relation de mappage d'événement, le nom de propriété de l'objet est utilisé comme nom d'événement et la valeur de propriété est utilisée comme fonction de traitement d'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
removeAllListeners
Annule tous les écouteurs de tous les événements de la file d'attente de traitement des objets. Si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.
1Object DgramSocket.removeAllListeners(String ev);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
Annule tous les écouteurs de tous les événements de la file d'attente de traitement des objets. Si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.
1Object DgramSocket.removeAllListeners(Array evs = []);
Paramètres d'appel :
- evs: Array, spécifiez le nom de l'événement
Résultat de retour :
- Object, Renvoie l'objet événement lui-même, ce qui est pratique pour l'appel en chaîne
setMaxListeners
La limite par défaut du nombre d'auditeurs, uniquement pour la compatibilité
1DgramSocket.setMaxListeners(Integer n);
Paramètres d'appel :
- n: Entier, spécifiez le nombre d'événements
getMaxListeners
Obtenez la limite par défaut du nombre d'auditeurs, uniquement pour la compatibilité
1Integer DgramSocket.getMaxListeners();
Résultat de retour :
- Integer, Retour au nombre limite par défaut
listeners
Tableau d'écouteurs pour l'événement spécifié de l'objet de requête
1Array DgramSocket.listeners(String ev);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Array, Renvoie un tableau d'écouteurs pour l'événement spécifié
listenerCount
Le nombre d'écouteurs pour l'événement spécifié de l'objet de requête
1Integer DgramSocket.listenerCount(String ev);
Paramètres d'appel :
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Integer, Renvoie le nombre d'écouteurs pour l'événement spécifié
Le nombre d'écouteurs pour l'événement spécifié de l'objet de requête
1
2Integer DgramSocket.listenerCount(Value o,
String ev);
Paramètres d'appel :
- o: Valeur, spécifiez l'objet de la requête
- ev: String, spécifiez le nom de l'événement
Résultat de retour :
- Integer, Renvoie le nombre d'écouteurs pour l'événement spécifié
eventNames
Interroger le nom d'événement de l'écouteur
1Array DgramSocket.eventNames();
Résultat de retour :
- Array, Renvoie un tableau de noms d'événements
emit
Déclencher un événement activement
1
2Boolean DgramSocket.emit(String ev,
...args);
Paramètres d'appel :
- ev: chaîne, nom de l'événement
- args: ..., paramètres d'événement, qui seront passés au gestionnaire d'événement
Résultat de retour :
- Boolean, Retourne à l'état du déclencheur d'événement, retourne vrai s'il y a un événement de réponse, sinon retourne faux
toString
Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Objet natif]", l'objet peut être ré-implémenté selon ses propres caractéristiques
1String DgramSocket.toString();
Résultat de retour :
- String, Renvoie la représentation sous forme de chaîne de l'objet
toJSON
Renvoie la représentation au format JSON de l'objet, renvoie généralement une collection d'attributs lisibles définis par l'objet
1Value DgramSocket.toJSON(String key = "");
Paramètres d'appel :
- key: chaîne, inutilisé
Résultat de retour :
- Value, Renvoie une valeur contenant JSON sérialisable