Objecte objecte incorporat
  1. portada
  2. objectes incorporats
  3. ObjectDgramSocket

ObjectDgramSocket

dgram.SocketL'objecte és una funció de paquet que encapsula la funcióEventEmitter.

Les instàncies de DgramSocket són proporcionades perdgram.createSocket() creat. creardgram.SocketLes instàncies no necessiten utilitzar la paraula clau nova.

Mètode de creació:

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

esdeveniment

DgramSocket hereta deEventEmitter, els canvis d'estat de l'objecte i la recepció de dades s'implementen en forma d'esdeveniments.

esdeveniment tancat

closeL'esdeveniment s'activarà després close()de tancar-ne un amb socket. Un cop activat aquest esdeveniment, no s'activaran cap esdeveniment socketnou en aquesta pàgina.message

esdeveniment d'error

Quan es produeixi algun error, errorl'esdeveniment s'activarà.

esdeveniment d'escolta

Quan un socketcomença a escoltar la informació del paquet, listeningl'esdeveniment s'activarà. Aquest esdeveniment s'activa immediatament després de crear el sòcol UDP.

esdeveniment de missatge

L'esdeveniment s'activa socketquan es rep un paquet nou . i es passarà com a paràmetres a la funció del controlador d'esdeveniments.messagemsgrinfo

  • 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 del remitent
    • size: número, mida del missatge

relació hereditària

%0 object object toString() toJSON() EventEmitter EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object->EventEmitter DgramSocket DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() addMembership() dropMembership() setMulticastTTL() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref() EventEmitter->DgramSocket

propietats estàtiques

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

funció de membre

bind

Aquest mètode faràdgram.SocketEscolteu la informació del paquet a les especificacions porti . addrS'activa un esdeveniment quan l'enllaç s'ha completat listening.

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

Paràmetres de trucada:

  • port: Enter, especifica el port d'enllaç. Si portno s'especifica o és 0, el sistema operatiu intentarà enllaçar un port aleatori.
  • addr: Cadena, especifica l'adreça d'enllaç. Si no s'especifica l'adreça, el sistema operatiu intentarà escoltar totes les adreces.

Aquest mètode faràdgram.SocketEscolteu la informació del paquet a les optsespecificacions porti . addressS'activa un esdeveniment quan l'enllaç s'ha completat listening.

1
DgramSocket.bind(Object opts) async;

Paràmetres de trucada:

  • opts: Objecte, especifica els 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ó a enviar
  • address: Cadena, especifiqueu l'adreça de destinació a enviar

Resultats de retorn:

  • Integer, retorneu la mida d'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: Sencer, comença a enviar des del desplaçament especificat
  • length: Enter, per enviar la longitud especificada
  • port: Enter, especifiqueu el port de destinació a enviar
  • address: Cadena, especifiqueu l'adreça de destinació a enviar

Resultats de retorn:

  • Integer, retorneu la mida d'enviament

address

Retorna un objecte que conté informació de l'adreça del sòcol. Per als sòcols UDP, l'objecte contindrà propietats d'adreça, família i port.

1
NObject DgramSocket.address();

Resultats de retorn:

  • NObject, retorna l'adreça d'enllaç de l'objecte

close

Tanqueu la presa actual

1
DgramSocket.close();

Tanqueu la presa actual

1
DgramSocket.close(Function callback);

Paràmetres de trucada:

  • callback: Funció, la funció de devolució de trucada després de finalitzar l'apagada, que equival a closeafegir un oient per a l'esdeveniment

getRecvBufferSize

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

1
Integer DgramSocket.getRecvBufferSize();

Resultats de retorn:

  • Integer, retorna els resultats de la consulta

getSendBufferSize

Consulteu la mida del buffer d'enviament del sòcol

1
Integer DgramSocket.getSendBufferSize();

Resultats de retorn:

  • Integer, retorna els resultats de la consulta

addMembership

Uniu-vos al grup de multidifusió a la multicastAddress i la multicastInterface donades mitjançant l'opció de sòcol IP_ADD_MEMBERSHIP. Si no s'especifica el paràmetre multicastInterface, el sistema operatiu selecciona una interfície i hi afegeix pertinença. Per afegir membres a cada interfície disponible, truqueu a addMembership diverses vegades, una vegada per a cada interfície.

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

Paràmetres de trucada:

  • multicastAddress: Cadena, especifica l'adreça del grup de multidifusió a unir-se
  • multicastInterface: Cadena, especifica la interfície del grup multicast per unir-se

dropMembership

Utilitzeu l'opció de sòcol IP_DROP_MEMBERSHIP per deixar el grup multicast a multicastAddress. El nucli crida automàticament aquest mètode quan es tanca el sòcol o el procés finalitza, de manera que la majoria de les aplicacions mai tindran un motiu per cridar aquest mètode.

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

Paràmetres de trucada:

  • multicastAddress: Cadena, especifica l'adreça del grup de multidifusió que s'ha de suprimir
  • multicastInterface: Cadena, especifica la interfície del grup de multidifusió que s'ha de suprimir

setMulticastTTL

Estableix l'opció de sòcol IP_MULTICAST_TTL

1
DgramSocket.setMulticastTTL(Integer ttl);

Paràmetres de trucada:

  • ttl: Enter, especifica el ttl que s'ha d'establir, el paràmetre ttl pot estar entre 0 i 255. El valor predeterminat a la majoria de sistemes és 1.

setRecvBufferSize

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

1
DgramSocket.setRecvBufferSize(Integer size);

Paràmetres de trucada:

  • size: Enter, especifiqueu la mida que s'ha d'establir

setSendBufferSize

Estableix la mida del buffer d'enviament del sòcol

1
DgramSocket.setSendBufferSize(Integer size);

Paràmetres de trucada:

  • size: Enter, especifiqueu la mida que s'ha d'establir

setBroadcast

Estableix o esborra 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();

Resultats de retorn:

  • DgramSocket, retorna l'objecte actual

unref

Permet que el procés fibjs surti. Permet que el procés fibjs surti durant l'enllaç d'objectes.

1
DgramSocket DgramSocket.unref();

Resultats de retorn:

  • DgramSocket, retorna l'objecte actual

on

Enllaceu un controlador d'esdeveniments a l'objecte

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Enllaceu un controlador d'esdeveniments a l'objecte

1
Object DgramSocket.on(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

addListener

Enllaceu un controlador d'esdeveniments a l'objecte

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Enllaceu un controlador d'esdeveniments a l'objecte

1
Object DgramSocket.addListener(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

prependListener

Enllaceu un controlador d'esdeveniments a l'origen de l'objecte

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Enllaceu un controlador d'esdeveniments a l'origen de l'objecte

1
Object DgramSocket.prependListener(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

once

Enllaça un controlador d'esdeveniments únic a l'objecte. El controlador únic només s'activarà una vegada.

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Enllaça un controlador d'esdeveniments únic a l'objecte. El controlador únic només s'activarà una vegada.

1
Object DgramSocket.once(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

prependOnceListener

Enllaceu un controlador d'esdeveniments a l'origen de l'objecte

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Enllaceu un controlador d'esdeveniments a l'origen de l'objecte

1
Object DgramSocket.prependOnceListener(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

off

Desassignar una funció de la cua de processament d'objectes

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

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

1
Object DgramSocket.off(String ev);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Desassignar una funció de la cua de processament d'objectes

1
Object DgramSocket.off(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

removeListener

Desassignar una funció de la cua de processament d'objectes

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

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

1
Object DgramSocket.removeListener(String ev);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Desassignar una funció de la cua de processament d'objectes

1
Object DgramSocket.removeListener(Object map);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

removeAllListeners

Cancel·la tots els oients de tots els esdeveniments de la cua de processament de l'objecte. Si s'especifica un esdeveniment, elimina tots els oients de l'esdeveniment especificat.

1
Object DgramSocket.removeAllListeners(String ev);

Paràmetres de trucada:

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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades en cadena

Cancel·la tots els oients de tots els esdeveniments de la cua de processament de l'objecte. Si s'especifica un esdeveniment, elimina 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

Resultats de retorn:

  • Object, retorna el propi objecte d'esdeveniment per facilitar les trucades 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

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

1
Integer DgramSocket.getMaxListeners();

Resultats de retorn:

  • Integer, retorna la quantitat límit predeterminada

listeners

Consulteu la matriu d'escolta per a l'esdeveniment especificat de l'objecte

1
Array DgramSocket.listeners(String ev);

Paràmetres de trucada:

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

Resultats de retorn:

  • Array, retorna la matriu d'escolta per a l'esdeveniment especificat

listenerCount

Consulteu el nombre d'oients per a l'esdeveniment especificat de l'objecte

1
Integer DgramSocket.listenerCount(String ev);

Paràmetres de trucada:

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

Resultats de retorn:

  • Integer, retorna el nombre d'oients per a l'esdeveniment especificat

Consulteu el nombre d'oients per a l'esdeveniment especificat de l'objecte

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

Paràmetres de trucada:

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

Resultats de retorn:

  • Integer, retorna el nombre d'oients per a l'esdeveniment especificat

eventNames

Consulta el nom de l'esdeveniment de l'oient

1
Array DgramSocket.eventNames();

Resultats de retorn:

  • Array, retorna una matriu de noms d'esdeveniments

emit

Activa activament un esdeveniment

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

Paràmetres de trucada:

  • ev: cadena, nom de l'esdeveniment
  • args: ..., els paràmetres d'esdeveniment es passaran a la funció de processament d'esdeveniments

Resultats de retorn:

  • Boolean, retorna l'estat de l'activador de l'esdeveniment, retorna true si hi ha un esdeveniment de resposta, en cas contrari retorna false

toString

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

1
String DgramSocket.toString();

Resultats de retorn:

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

toJSON

Retorna una representació en format JSON de l'objecte, generalment retornant una col·lecció de propietats llegibles definides per l'objecte.

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

Paràmetres de trucada:

  • key: Corda, no utilitzada

Resultats de retorn:

  • Value, retorna un valor que conté JSON serializable
© Copyright 2012-2024 fibjs.org | Doneu-nos suport