Objecte objecte incorporat

Objecte DgramSocket

dgram.Socket L'objecte és un paquet que encapsula la funció del paquet de dades EventEmitter.

La instància DgramSocket és creada per dgram.createSocket() Creat. creardgram.Socket La instància no necessita utilitzar la paraula clau nova.

Mètode de creació:

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

esdeveniment

DgramSocket heretat de EventEmitter, El canvi d'estat de l'objecte i l'acceptació de dades es realitzen en forma d'esdeveniments.

tancar l'esdeveniment

closeEls esdeveniments es faran servir close()per tancar un socketactivador després. L'esdeveniment Un cop activat, socketno activarà un messageesdeveniment nou .

esdeveniment d'error

Quan es produeixi un error, l' erroresdeveniment s'activarà.

esdeveniment d’escolta

Quan es socketcomença a escoltar informació de paquets, listeningl'esdeveniment s'activarà. Aquest esdeveniment s'activarà immediatament després de crear el sòcol UDP.

missatge d'esdeveniment

Quan es socketrep un nou paquet , l' messageesdeveniment s'activarà. msgI es va rinfopassar al controlador d'esdeveniments com a paràmetre.

  • msg: Buffer, informació
  • rinfo: Objecte, informació d’adreça remota
    • address: cadena, adreça del remitent
    • family: cadena, tipus d'adreça ('IPv4' o 'IPv6')
    • port: número, port remitent
    • size: número, mida del missatge

Herència

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>DgramSocket|bind();send();address();close();getRecvBufferSize();getSendBufferSize();setRecvBufferSize();setSendBufferSize();setBroadcast();ref();unref()] [object] <:- [EventEmitter] [EventEmitter] <:- [DgramSocket] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object toString() toJSON() DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref()

Propietats estàtiques

defaultMaxListeners

Enter, el nombre màxim d'oients global predeterminat

1
static Integer DgramSocket.defaultMaxListeners;

Funció de membre

bind

Aquest mètode es farà dgram.SocketEspecificar porti addrescoltar informació sobre paquets. Quan la vinculació provoca un listeningesdeveniment complet .

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

Paràmetres de trucada:

  • port: Enter, especifica l’enllaç de ports, si portno s’especifica o és zero, el sistema intenta lligar un port aleatori
  • addr: Cadena, especifiqueu l'adreça d'enllaç. Si no s'especifica l'adreça, el sistema operatiu intentarà escoltar totes les adreces.

Aquest mètode es farà dgram.SocketEn optsespecificar porti addressescoltar a la informació del paquet. Quan la vinculació provoca un listeningesdeveniment complet .

1
DgramSocket.bind(Object opts) async;

Paràmetres de trucada:

  • opts: Objecte, especifiqueu paràmetres d’enllaç

send

Envieu un paquet al sòcol

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

Paràmetres de trucada:

  • msg: Buffer, Especifiqueu les dades a enviar
  • port: Enter, especifiqueu el port de destinació per enviar
  • address: Cadena, especifiqueu l'adreça de destinació per enviar

Resultat de retorn:

  • Integer, Retorna la mida de l'enviament

Envieu un paquet al sòcol

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

Paràmetres de trucada:

  • msg: Buffer, Especifiqueu les dades a enviar
  • offset: Enter, comenceu a enviar des del desplaçament especificat
  • length: Enter, la durada especificada de l'enviament
  • port: Enter, especifiqueu el port de destinació per enviar
  • address: Cadena, especifiqueu l'adreça de destinació per enviar

Resultat de retorn:

  • Integer, Retorna la mida de l'enviament

address

Retorna un objecte que conté informació sobre l'adreça de sòcol. Per al sòcol UDP, aquest objecte contindrà atributs d'adreça, família i port.

1
NObject DgramSocket.address();

Resultat de retorn:

  • NObject, Retorna l'adreça d'enquadernació d'objectes

close

Tanqueu el sòcol actual

1
DgramSocket.close();

Tanqueu el sòcol actual

1
DgramSocket.close(Function callback);

Paràmetres de trucada:

  • callback: Funció: s'apaga després de completar la funció de devolució de trucada, que equival a closeafegir un oient d'esdeveniments

getRecvBufferSize

Socket de consulta que rep la mida de la memòria intermèdia

1
Integer DgramSocket.getRecvBufferSize();

Resultat de retorn:

  • Integer, Retorna el resultat de la consulta

getSendBufferSize

Consulteu la mida del buffer d’enviament de sòcol

1
Integer DgramSocket.getSendBufferSize();

Resultat de retorn:

  • Integer, Retorna el resultat de la consulta

setRecvBufferSize

Estableix la mida del buffer de recepció de sòcol

1
DgramSocket.setRecvBufferSize(Integer size);

Paràmetres de trucada:

  • size: Enter, especifiqueu la mida que voleu establir

setSendBufferSize

Estableix la mida de la memòria intermèdia d’enviament de sòcol

1
DgramSocket.setSendBufferSize(Integer size);

Paràmetres de trucada:

  • size: Enter, especifiqueu la mida que voleu establir

setBroadcast

Definiu o esborreu l'opció de sòcol SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Paràmetres de trucada:

  • flag: Booleà, quan s'estableix en true, els paquets UDP s'enviaran a l'adreça de difusió d'una interfície local

ref

Eviteu que el procés fibjs surti i eviteu que el procés fibjs surti durant l'enllaç d'objectes

1
DgramSocket DgramSocket.ref();

Resultat de retorn:

  • DgramSocket, Retorna l'objecte actual

unref

Permet que el procés fibjs surti i permeti que el procés fibjs surti durant la vinculació d'objectes

1
DgramSocket DgramSocket.unref();

Resultat de retorn:

  • DgramSocket, Retorna l'objecte actual

on

Enllaça un gestor d'esdeveniments a l'objecte

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Enllaça un gestor d'esdeveniments a l'objecte

1
Object DgramSocket.on(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

addListener

Enllaça un gestor d'esdeveniments a l'objecte

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Enllaça un gestor d'esdeveniments a l'objecte

1
Object DgramSocket.addListener(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

prependListener

Enllaça un gestor d'esdeveniments a l'inici de l'objecte

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Enllaça un gestor d'esdeveniments a l'inici de l'objecte

1
Object DgramSocket.prependListener(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

once

Enllaceu una funció de processament d'esdeveniments puntuals a l'objecte, la funció de processament puntual només s'activarà una vegada

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Enllaceu una funció de processament d'esdeveniments puntuals a l'objecte, la funció de processament puntual només s'activarà una vegada

1
Object DgramSocket.once(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

prependOnceListener

Enllaça un gestor d'esdeveniments a l'inici de l'objecte

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Enllaça un gestor d'esdeveniments a l'inici de l'objecte

1
Object DgramSocket.prependOnceListener(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, s'utilitzarà el nom de la propietat de l'objecte com a nom de l'esdeveniment i el valor de la propietat s'utilitzarà com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

off

Cancel·leu la funció especificada a la cua de processament d'objectes

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Cancel·leu totes les funcions de la cua de processament d'objectes

1
Object DgramSocket.off(String ev);

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Cancel·leu la funció especificada a la cua de processament d'objectes

1
Object DgramSocket.off(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, el nom de la propietat de l'objecte s'utilitza com a nom d'esdeveniment i el valor de la propietat s'utilitza com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

removeListener

Cancel·leu la funció especificada a la cua de processament d'objectes

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

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment
  • func: Funció, especifiqueu la funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Cancel·leu totes les funcions de la cua de processament d'objectes

1
Object DgramSocket.removeListener(String ev);

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Cancel·leu la funció especificada a la cua de processament d'objectes

1
Object DgramSocket.removeListener(Object map);

Paràmetres de trucada:

  • map: Objecte, especifiqueu la relació de mapatge d'esdeveniments, el nom de la propietat de l'objecte s'utilitza com a nom d'esdeveniment i el valor de la propietat s'utilitza com a funció de processament d'esdeveniments

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

removeAllListeners

Cancel·leu tots els oients de tots els esdeveniments de la cua de processament d'objectes. Si s'especifica un esdeveniment, traieu tots els oients de l'esdeveniment especificat.

1
Object DgramSocket.removeAllListeners(String ev);

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

Cancel·leu tots els oients de tots els esdeveniments de la cua de processament d'objectes. Si s'especifica un esdeveniment, traieu tots els oients de l'esdeveniment especificat.

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

Paràmetres de trucada:

  • evs: Matriu, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Object, Torneu l'objecte d'esdeveniment en si mateix, que és convenient per a la trucada en cadena

setMaxListeners

El límit predeterminat del nombre d’oients, només per compatibilitat

1
DgramSocket.setMaxListeners(Integer n);

Paràmetres de trucada:

  • n: Enter, especifiqueu el nombre d'esdeveniments

getMaxListeners

Obteniu el límit predeterminat del nombre d'oients, només per compatibilitat

1
Integer DgramSocket.getMaxListeners();

Resultat de retorn:

  • Integer, Torneu al número límit per defecte

listeners

Matriu d'oients per a l'esdeveniment especificat de l'objecte de consulta

1
Array DgramSocket.listeners(String ev);

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Array, Retorna una matriu d'oients per a l'esdeveniment especificat

listenerCount

El nombre d'oients de l'esdeveniment especificat de l'objecte de consulta

1
Integer DgramSocket.listenerCount(String ev);

Paràmetres de trucada:

  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Integer, Retorna el nombre d'oients de l'esdeveniment especificat

El nombre d'oients de l'esdeveniment especificat de l'objecte de consulta

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

Paràmetres de trucada:

  • o: Valor, especifiqueu l'objecte de la consulta
  • ev: Cadena, especifiqueu el nom de l'esdeveniment

Resultat de retorn:

  • Integer, Retorna el nombre d'oients de l'esdeveniment especificat

eventNames

Consulteu el nom de l'esdeveniment de l'oient

1
Array DgramSocket.eventNames();

Resultat de retorn:

  • Array, Retorna una matriu de noms d'esdeveniments

emit

Activar un esdeveniment activament

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

Paràmetres de trucada:

  • ev: Cadena, nom de l'esdeveniment
  • args: ..., paràmetres d'esdeveniments, que es passaran al gestor d'esdeveniments

Resultat de retorn:

  • Boolean, Torneu a l'estat d'activació de l'esdeveniment, torneu cert si hi ha un esdeveniment de resposta, en cas contrari torneu a fals

toString

Retorna la representació de cadena de l'objecte, generalment retorna "[Objecte natiu]", l'objecte es pot tornar a implementar segons les seves pròpies característiques

1
String DgramSocket.toString();

Resultat de retorn:

  • String, Retorna la representació de cadena de l'objecte

toJSON

Retorna la representació en format JSON de l'objecte, generalment retorna una col·lecció d'atributs llegibles definits per l'objecte

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

Paràmetres de trucada:

  • key: Cadena, sense utilitzar

Resultat de retorn:

  • Value, Retorna un valor que conté JSON serialitzable