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 (). Le nouveau mot clé n'est pas requis pour créer une instance dgram.Socket .

Comment créer:

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, ainsi que la réception des données, sont implémentés sous forme d'événements.

événement proche

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

événement d'erreur

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

événement d'écoute

Lorsqu'un socket commence à écouter les informations du paquet, l'événement d' listening est 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 le socket , l'événement de message sera déclenché. msg et rinfo seront transmis en tant que paramètres à la fonction de traitement des é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 émetteur
- size : nombre, taille du message

Héritage

Propriété statique

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

Fonction membre

bind

Cette méthode amènera dgram.Socket à écouter les informations du paquet sur le port et l' addr spécifiés. Une fois la liaison 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 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 amènera dgram.Socket à écouter les informations du paquet sur le port et l' address spécifiés par opts . Une fois la liaison 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 le socket

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

Paramètres d'appel:

msg : Buffer , spécifiez les données envoyées
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 , renvoyer la taille de l'envoi

Envoyer un paquet sur le 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 envoyées
offset : Integer, commence à envoyer à partir du décalage spécifié
length : Entier, envoyer la longueur 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 , renvoyer la taille de l'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 , retourne l'adresse de liaison de l'objet

close

Fermez la prise actuelle

1DgramSocket.close();

Fermez la prise actuelle

1
DgramSocket.close(Function callback);

Paramètres d'appel:

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

getRecvBufferSize

Interroger la taille du tampon de réception du socket

1Integer DgramSocket.getRecvBufferSize();

Résultat de retour:

Integer , retourne le résultat de la requête

getSendBufferSize

Taille du tampon d'envoi du socket de requête

1Integer DgramSocket.getSendBufferSize();

Résultat de retour:

Integer , retourne 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 de 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

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'un objet

1DgramSocket DgramSocket.ref();

Résultat de retour:

DgramSocket , retourne l'objet courant

unref

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

1DgramSocket 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 : Function, 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 les appels chaînés

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

1
Object DgramSocket.on(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, 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 les appels chaînés

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

1
Object DgramSocket.addListener(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, 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 les appels chaînés

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

1
Object DgramSocket.prependListener(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

once

Lier un gestionnaire d'événements ponctuel à l'objet, le gestionnaire ponctuel ne se déclenchera 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 : Function, 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 les appels chaînés

Lier un gestionnaire d'événements ponctuel à l'objet, le gestionnaire ponctuel ne se déclenchera qu'une seule fois

1
Object DgramSocket.once(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

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 : Function, 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 les appels chaînés

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

1
Object DgramSocket.prependOnceListener(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet sera utilisé comme nom d'événement et la valeur d'attribut sera utilisée comme gestionnaire d'événements

Résultat de retour:

Object , renvoie l'objet événement lui-même, ce qui est pratique pour les appels chaînés

off

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

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

Paramètres d'appel:

ev : String, spécifiez le nom de l'événement
func : Function, 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 les appels chaînés

Annuler toutes les fonctions de la file d'attente de traitement d'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, ce qui est pratique pour les appels chaînés

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

1
Object DgramSocket.off(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet est utilisé comme nom d'événement et la valeur d'attribut 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 les appels chaînés

removeListener

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

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

Paramètres d'appel:

ev : String, spécifiez le nom de l'événement
func : Function, 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 les appels chaînés

Annuler toutes les fonctions de la file d'attente de traitement d'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, ce qui est pratique pour les appels chaînés

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

1
Object DgramSocket.removeListener(Object map);

Paramètres d'appel:

map : Object, spécifie la relation de mappage d'événements, le nom d'attribut d'objet est utilisé comme nom d'événement et la valeur d'attribut 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 les appels chaînés

removeAllListeners

Annulez tous les écouteurs de tous les événements de la file d'attente de traitement d'objets et, si des événements spécifiés, supprimez tous les écouteurs des événements spécifiés.

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, ce qui est pratique pour les appels chaînés

setMaxListeners

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

1DgramSocket.setMaxListeners(Integer n);

Paramètres d'appel:

n : Entier, spécifiez le nombre d'événements

getMaxListeners

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

1Integer DgramSocket.getMaxListeners();

Résultat de retour:

Integer , renvoie le nombre limite par défaut

listeners

Tableau d'écoute de 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 , retourne 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 , 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 d'événement seront transmis à la fonction de 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 "[Native Object]", l'objet peut être réimplémenté selon ses propres caractéristiques

1
String DgramSocket.toString();

Résultat de retour:

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

toJSON

Renvoie la représentation 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 , retourne une valeur contenant JSON sérialisable

Guide de développement

Module de base

Objets intégrés

Module communautaire

Objet DgramSocket

un événement

événement proche

événement d'erreur

événement d'écoute

événement de message

Héritage

Propriété statique

defaultMaxListeners

Fonction membre

bind

send

address

close

getRecvBufferSize

getSendBufferSize

setRecvBufferSize

setSendBufferSize

setBroadcast

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON