ObjetDgramSocket

dgram.SocketL'objet est une fonction de package qui encapsule la fonctionEventEmitter.

Les instances DgramSocket sont fournies pardgram.createSocket() créé. créerdgram.SocketLes instances n'ont pas besoin d'utiliser le nouveau mot-clé.

Méthode de création :

1
2
var dgram = require('dgram');
var sock = dgram.createSocket('udp4');

événement

DgramSocket hérite deEventEmitter, les changements d'état des objets et la réception des données sont tous implémentés sous forme d'événements.

clôturer l'événement

closeL'événement sera déclenché après close()la fermeture d'un événement à l'aide de socket. Une fois cet événement déclenché, socketaucun nouvel messageévénement ne sera déclenché sur cette page.

événement d'erreur

Lorsqu'une erreur se produit, errorl'événement sera déclenché.

événement d'écoute

Lorsque l'on socketcommence à écouter les informations sur les paquets, listeningl'événement est déclenché. Cet événement est déclenché immédiatement après la création du socket UDP.

événement de message

L'événement est déclenché socketlorsqu'un nouveau paquet est reçu. et sera transmis en tant que paramètres à la fonction de gestionnaire d'événements.messagemsgrinfo

msg:Buffer,information
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 de l'expéditeur
- size: numéro, taille du message

relation d'héritage

propriétés statiques

defaultMaxListeners

Entier, le nombre maximum global d'auditeurs par défaut

1
static Integer DgramSocket.defaultMaxListeners;

fonction membre

bind

Cette méthode feradgram.SocketÉcoutez les informations sur les paquets sur les fichiers portet . addrUn événement est déclenché lorsque la liaison est terminée listening.

1
2
DgramSocket.bind(Integer port = 0,
    String addr = "") async;

Paramètres d'appel :

port: Nombre entier, spécifie le port de liaison. S'il portn'est pas spécifié ou s'il est égal à 0, le système d'exploitation tentera de lier un port aléatoire.
addr : String,spécifie l'adresse de liaison. Si l'adresse n'est pas spécifiée, le système d'exploitation essaiera d'écouter toutes les adresses.

Cette méthode feradgram.SocketÉcoutez les informations sur les paquets sur les optsfichiers portet . addressUn événement est déclenché lorsque la liaison est terminée listening.

1
DgramSocket.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
3
Integer DgramSocket.send(Buffer msg,
    Integer port,
    String address = "") async;

Paramètres d'appel :

msg:Buffer, précisez les données à envoyer
port: Entier, spécifiez le port de destination à envoyer
address: Chaîne, spécifiez l'adresse de destination à envoyer

Résultats de retour :

Integer, renvoyer la taille d'envoi

Envoyer un paquet sur la socket

1
2
3
4
5
Integer DgramSocket.send(Buffer msg,
    Integer offset,
    Integer length,
    Integer port,
    String address = "") async;

Paramètres d'appel :

msg:Buffer, précisez les données à envoyer
offset: Nombre entier, commencez l'envoi à partir du décalage spécifié
length: Entier, pour envoyer la longueur spécifiée
port: Entier, spécifiez le port de destination à envoyer
address: Chaîne, spécifiez l'adresse de destination à envoyer

Résultats de retour :

Integer, renvoyer la taille d'envoi

address

Renvoie un objet contenant des informations sur l'adresse du socket. Pour les sockets UDP, l'objet contiendra les propriétés d'adresse, de famille et de port.

1NObject DgramSocket.address();

Résultats de retour :

NObject, renvoie l'adresse de liaison de l'objet

close

Fermez la prise de courant

1DgramSocket.close();

Fermez la prise de courant

1
DgramSocket.close(Function callback);

Paramètres d'appel :

callback: Fonction, la fonction de rappel une fois l'arrêt terminé, ce qui équivaut à closeajouter un écouteur pour l'événement

getRecvBufferSize

Interroger la taille du tampon de réception du socket

1Integer DgramSocket.getRecvBufferSize();

Résultats de retour :

Integer, renvoie les résultats de la requête

getSendBufferSize

Interroger la taille du tampon d'envoi du socket

1Integer DgramSocket.getSendBufferSize();

Résultats de retour :

Integer, renvoie les résultats de la requête

addMembership

Rejoignez le groupe de multidiffusion à l'adresse multicastAddress et à la multicastInterface données à l'aide de l'option de socket IP_ADD_MEMBERSHIP. Si le paramètre multicastInterface n'est pas spécifié, le système d'exploitation sélectionne une interface et y ajoute une adhésion. Pour ajouter une adhésion à chaque interface disponible, appelez addMembership plusieurs fois, une fois pour chaque interface.

1
2
DgramSocket.addMembership(String multicastAddress,
    String multicastInterface = "");

Paramètres d'appel :

multicastAddress: String, spécifie l'adresse du groupe de multidiffusion à rejoindre
multicastInterface: String, spécifie l'interface du groupe de multidiffusion à rejoindre

dropMembership

Utilisez l'option de socket IP_DROP_MEMBERSHIP pour quitter le groupe de multidiffusion à multicastAddress. Le noyau appelle automatiquement cette méthode lorsque le socket est fermé ou que le processus se termine, de sorte que la plupart des applications n'auront jamais de raison d'appeler cette méthode.

1
2
DgramSocket.dropMembership(String multicastAddress,
    String multicastInterface = "");

Paramètres d'appel :

multicastAddress: String, spécifie l'adresse du groupe multicast à supprimer
multicastInterface: String, spécifie l'interface du groupe multicast à supprimer

setMulticastTTL

Définir l'option de socket IP_MULTICAST_TTL

1DgramSocket.setMulticastTTL(Integer ttl);

Paramètres d'appel :

ttl: Entier, précise le ttl à définir, le paramètre ttl peut être compris entre 0 et 255. La valeur par défaut sur la plupart des systèmes est 1.

setRecvBufferSize

Définir la taille du tampon de réception du socket

1DgramSocket.setRecvBufferSize(Integer size);

Paramètres d'appel :

size: Entier, précisez 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, précisez la taille à définir

setBroadcast

Définir ou désactiver l'option de socket SO_BROADCAST

1
DgramSocket.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 terminer pendant la liaison d'objet

1DgramSocket DgramSocket.ref();

Résultats de retour :

DgramSocket, renvoie l'objet actuel

unref

Autoriser le processus fibjs à se terminer. Autoriser le processus fibjs à se terminer pendant la liaison d'objet.

1DgramSocket DgramSocket.unref();

Résultats de retour :

DgramSocket, renvoie l'objet actuel

on

Lier un gestionnaire d'événements à l'objet

1
2
Object DgramSocket.on(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Lier un gestionnaire d'événements à l'objet

1
Object DgramSocket.on(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet sera utilisé comme nom d'événement et la valeur de l'attribut sera utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

addListener

Lier un gestionnaire d'événements à l'objet

1
2
Object DgramSocket.addListener(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Lier un gestionnaire d'événements à l'objet

1
Object DgramSocket.addListener(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet sera utilisé comme nom d'événement et la valeur de l'attribut sera utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

prependListener

Lier un gestionnaire d'événements à l'origine de l'objet

1
2
Object DgramSocket.prependListener(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Lier un gestionnaire d'événements à l'origine de l'objet

1
Object DgramSocket.prependListener(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet sera utilisé comme nom d'événement et la valeur de l'attribut sera utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

once

Liez un gestionnaire d'événement unique à l'objet.Le gestionnaire unique ne sera déclenché qu'une seule fois.

1
2
Object DgramSocket.once(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Liez un gestionnaire d'événement unique à l'objet.Le gestionnaire unique ne sera déclenché qu'une seule fois.

1
Object DgramSocket.once(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet sera utilisé comme nom d'événement et la valeur de l'attribut sera utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

prependOnceListener

Lier un gestionnaire d'événements à l'origine de l'objet

1
2
Object DgramSocket.prependOnceListener(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Lier un gestionnaire d'événements à l'origine de l'objet

1
Object DgramSocket.prependOnceListener(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet sera utilisé comme nom d'événement et la valeur de l'attribut sera utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

off

Désaffecter une fonction de la file d'attente de traitement des objets

1
2
Object DgramSocket.off(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Annuler toutes les fonctions dans la file d'attente de traitement des objets

1
Object DgramSocket.off(String ev);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Désaffecter une fonction de la file d'attente de traitement des objets

1
Object DgramSocket.off(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet est utilisé comme nom d'événement et la valeur de l'attribut est utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

removeListener

Désaffecter une fonction de la file d'attente de traitement des objets

1
2
Object DgramSocket.removeListener(String ev,
    Function func);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement
func: Fonction, spécifiez la fonction de traitement des événements

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Annuler toutes les fonctions dans la file d'attente de traitement des objets

1
Object DgramSocket.removeListener(String ev);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Désaffecter une fonction de la file d'attente de traitement des objets

1
Object DgramSocket.removeListener(Object map);

Paramètres d'appel :

map: Objet, spécifie la relation de mappage d'événement, le nom de l'attribut de l'objet est utilisé comme nom d'événement et la valeur de l'attribut est utilisée comme fonction de traitement d'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

removeAllListeners

Annule tous les écouteurs de tous les événements de la file d'attente de traitement de l'objet. Si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.

1
Object DgramSocket.removeAllListeners(String ev);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

Annule tous les écouteurs de tous les événements de la file d'attente de traitement de l'objet. Si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.

1
Object DgramSocket.removeAllListeners(Array evs = []);

Paramètres d'appel :

evs: Tableau, précisez le nom de l'événement

Résultats de retour :

Object, renvoie l'objet événement lui-même pour faciliter les appels en chaîne

setMaxListeners

La limite par défaut du nombre d'auditeurs, pour des raisons de compatibilité uniquement

1DgramSocket.setMaxListeners(Integer n);

Paramètres d'appel :

n: Entier, précisez le nombre d'événements

getMaxListeners

Obtient le nombre limite par défaut d'écouteurs, pour des raisons de compatibilité uniquement

1Integer DgramSocket.getMaxListeners();

Résultats de retour :

Integer, renvoie la quantité limite par défaut

listeners

Interrogez le tableau d'écoute pour l'événement spécifié de l'objet

1
Array DgramSocket.listeners(String ev);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement

Résultats de retour :

Array, renvoie le tableau d'écoute pour l'événement spécifié

listenerCount

Interroger le nombre d'écouteurs pour l'événement spécifié de l'objet

1
Integer DgramSocket.listenerCount(String ev);

Paramètres d'appel :

ev: String, spécifie le nom de l'événement

Résultats de retour :

Integer, renvoie le nombre d'écouteurs pour l'événement spécifié

Interroger le nombre d'écouteurs pour l'événement spécifié de l'objet

1
2Integer DgramSocket.listenerCount(Value o,
    String ev);

Paramètres d'appel :

o: Valeur, précise l'objet de la requête
ev: String, spécifie le nom de l'événement

Résultats de retour :

Integer, renvoie le nombre d'écouteurs pour l'événement spécifié

eventNames

Nom de l'événement d'écoute de requête

1
Array DgramSocket.eventNames();

Résultats de retour :

Array, renvoie un tableau de noms d'événements

emit

Déclencher activement un événement

1
2
Boolean DgramSocket.emit(String ev,
    ...args);

Paramètres d'appel :

ev: Chaîne, nom de l'événement
args: ..., les paramètres de l'événement seront transmis à la fonction de traitement des événements

Résultats de retour :

Boolean, renvoie l'état du déclencheur d'événement, renvoie vrai s'il y a un événement de réponse, sinon renvoie faux

toString

Renvoie la représentation sous forme de chaîne de l'objet. Généralement, "[Native Object]" est renvoyé. L'objet peut être réimplémenté en fonction de ses propres caractéristiques.

1
String DgramSocket.toString();

Résultats de retour :

String, renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie une représentation au format JSON de l'objet, renvoyant généralement une collection de propriétés lisibles définies par l'objet.

1
Value DgramSocket.toJSON(String key = "");

Paramètres d'appel :

key: Chaîne, non utilisée

Résultats de retour :

Value, renvoie une valeur contenant du JSON sérialisable

Guide de développement

Module de base

objets intégrés

module communautaire

ObjetDgramSocket

événement

clôturer l'événement

événement d'erreur

événement d'écoute

événement de message

relation d'héritage

propriétés statiques

defaultMaxListeners

fonction membre

bind

send

address

close

getRecvBufferSize

getSendBufferSize

addMembership

dropMembership

setMulticastTTL

setRecvBufferSize

setSendBufferSize

setBroadcast

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON