Objet objet intégré

Objet DgramSocket

dgram.Socket objet dgram.Socket est une fonction d'encapsulation d'une fonctionnalité EventEmitter paquet EventEmitter .

L'instance DgramSocket est créée par dgram.createSocket (). dgram.Socket pas nécessaire d'utiliser le nouveau mot-clé pour créer dgram.Socket instance de dgram.Socket .

Méthode de création:

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

un événement

DgramSocket hérite d' EventEmitter , le changement d'état de l'objet et la réception des données sont tous réalisés sous forme d'événements.

fermer l'événement

close événement close sera déclenché après la fermeture d'un socket utilisant close() . Une fois cet événement déclenché, aucun nouvel événement de message ne sera déclenché sur cette socket .

événement d'erreur

Lorsqu'une erreur se produit, l'événement d' error est déclenché.

événement d'écoute

Quand une socket commence à écouter les informations de paquet, l'événement d' listening 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 reçu par la socket , l'événement de message sera déclenché. msg et rinfo seront transmis en tant que paramètres au gestionnaire d'événements.

  • msg : Buffer , message
  • 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 : nombre, taille du message

Héritage

Propriétés statiques

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

Fonction membre

bind

Cette méthode dgram.Socket surveiller les informations de paquet sur le port et l' addr spécifiés. Lorsque la liaison est terminée, un événement d' listening est déclenché.

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

Paramètres d'appel:

  • port : entier, spécifiez le port de liaison, si le port pas spécifié ou est 0, le système d'exploitation essaiera 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 toutes les adresses.

Cette méthode dgram.Socket surveiller les informations du paquet sur le port et l' address spécifiés par opts . Lorsque la liaison est terminée, un événement d' listening est déclenché.

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 prise

1 2 3
Integer 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 : String, spécifiez l'adresse de destination à envoyer

Résultat de retour:

  • Integer , renvoie la taille d'envoi

Envoyer un paquet sur la prise

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 , spécifiez les données à envoyer
  • offset : Entier, commence l'envoi à partir du décalage spécifié
  • length : Integer, la durée d'envoi spécifiée
  • port : entier, spécifiez le port de destination pour l'envoi
  • address : String, spécifiez l'adresse de destination à envoyer

Résultat de retour:

  • Integer , renvoie la taille d'envoi

address

Renvoie un objet contenant des informations d'adresse de socket. Pour le socket UDP, l'objet contiendra les attributs d'adresse, de famille et de port.

1
NObject DgramSocket.address();

Résultat de retour:

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

close

Fermer la prise actuelle

1
DgramSocket.close();

Fermer la prise actuelle

1
DgramSocket.close(Function callback);

Paramètres d'appel:

  • callback : Function, la fonction de rappel après la fermeture, cela équivaut à ajouter un écouteur à l'événement close

getRecvBufferSize

Socket de requête recevant la taille du tampon

1
Integer DgramSocket.getRecvBufferSize();

Résultat de retour:

  • Integer , renvoie le résultat de la requête

getSendBufferSize

Query socket send buffer size

1
Integer DgramSocket.getSendBufferSize();

Résultat de retour:

  • Integer , renvoie le résultat de la requête

setRecvBufferSize

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

1
DgramSocket.setRecvBufferSize(Integer size);

Paramètres d'appel:

  • size : Integer, spécifiez la taille à définir

setSendBufferSize

Définir la taille du tampon d'envoi du socket

1
DgramSocket.setSendBufferSize(Integer size);

Paramètres d'appel:

  • size : Integer, spécifiez la taille à définir

setBroadcast

Définissez ou désactivez l'option de socket SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Paramètres d'appel:

  • flag : Boolean, lorsqu'il est défini sur true, les paquets UDP seront envoyés à l'adresse de diffusion d'une interface locale

ref

Empêchez le processus fibjs de se terminer et empêchez le processus fibjs de se terminer pendant la liaison d'objet

1
DgramSocket DgramSocket.ref();

Résultat de retour:

  • DgramSocket , retourne l'objet courant

unref

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

1
DgramSocket DgramSocket.unref();

Résultat de retour:

  • DgramSocket , retourne l'objet courant

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é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, appel facile à enchaîner

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

1
Object DgramSocket.on(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera le nom de l'événement et la valeur de la propriété sera la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

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é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, appel facile à enchaîner

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

1
Object DgramSocket.addListener(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera le nom de l'événement et la valeur de la propriété sera la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

prependListener

Lier un gestionnaire d'événements au début de l'objet

1 2
Object 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, appel facile à enchaîner

Lier un gestionnaire d'événements au début de l'objet

1
Object DgramSocket.prependListener(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera le nom de l'événement et la valeur de la propriété sera la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

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 2
Object 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, appel facile à enchaîner

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
Object DgramSocket.once(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera le nom de l'événement et la valeur de la propriété sera la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

prependOnceListener

Lier un gestionnaire d'événements au début de l'objet

1 2
Object 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, appel facile à enchaîner

Lier un gestionnaire d'événements au début de l'objet

1
Object DgramSocket.prependOnceListener(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera le nom de l'événement et la valeur de la propriété sera la fonction de traitement des événements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

off

Annuler la fonction spécifiée 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é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, appel facile à enchaîner

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

1
Object 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, appel facile à enchaîner

Annuler la fonction spécifiée de la file d'attente de traitement des objets

1
Object DgramSocket.off(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événement, le nom de propriété d'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, appel facile à enchaîner

removeListener

Annuler la fonction spécifiée 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é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, appel facile à enchaîner

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

1
Object 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, appel facile à enchaîner

Annuler la fonction spécifiée de la file d'attente de traitement des objets

1
Object DgramSocket.removeListener(Object map);

Paramètres d'appel:

  • map : objet, spécifiez la relation de mappage d'événements, 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énements

Résultat de retour:

  • Object , renvoie l'objet événement lui-même, appel facile à enchaîner

removeAllListeners

Annulez tous les écouteurs de tous les événements de la file d'attente de traitement des objets. Si un événement est spécifié, supprimez tous les écouteurs de l'événement spécifié.

1
Object 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, appel facile à enchaîner

setMaxListeners

La limite par défaut du nombre d'écouteurs, uniquement pour la compatibilité

1
DgramSocket.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'écouteurs, uniquement pour des raisons de compatibilité

1
Integer DgramSocket.getMaxListeners();

Résultat de retour:

  • Integer , renvoie le nombre limite par défaut

listeners

Tableau d'écouteurs pour l'événement spécifié de l'objet de requête

1
Array 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

1
Integer 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é

eventNames

Nom de l'événement de l'écouteur de requête

1
Array DgramSocket.eventNames();

Résultat de retour:

  • Array , retourne 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 : ..., paramètres d'événement, qui seront transmis au gestionnaire d'événements

Résultat de retour:

  • Boolean , renvoie l'état du déclencheur d'événement, renvoie true s'il y a un événement de réponse, sinon retourne false

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Native Object]", l'objet peut être réimplémenté selon ses propres caractéristiques

1
String 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

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

Paramètres d'appel:

  • key : chaîne, inutilisée

Résultat de retour:

  • Value , renvoie une valeur contenant JSON sérialisable