Oggetto oggetto incorporato

Oggetto DgramSocket

dgram.Socket L'oggetto è un pacchetto che incapsula la funzione EventEmitter.

L'istanza di DgramSocket è creata da dgram.createSocket() Creato. crearedgram.Socket Non è necessario che l'istanza utilizzi la nuova parola chiave.

Metodo di creazione:

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

evento

DgramSocket ereditato da EventEmitter, Il cambiamento di stato dell'oggetto e l'accettazione dei dati sono tutti realizzati sotto forma di eventi.

chiudere l'evento

closeGli eventi verranno utilizzati close()per chiudere un sockettrigger dopo. L'evento Una volta attivato, questo socketnon attiverà un nuovo messageevento.

evento di errore

Quando si verifica un errore, l' errorevento verrà attivato.

evento di ascolto

Quando un socketinizio di ascoltare le informazioni dei pacchetti, listeningl'evento verrà attivato. Questo evento verrà attivato immediatamente dopo la creazione del socket UDP.

messaggio evento

Quando viene socketricevuto un nuovo pacchetto , l' messageevento verrà attivato. msgE rinfopassato al gestore eventi come parametro.

  • msg: Buffer,notizia
  • rinfo: Oggetto, informazioni sull'indirizzo remoto
    • address: stringa, indirizzo del mittente
    • family: stringa, tipo di indirizzo ('IPv4' o'IPv6')
    • port: numero, porta mittente
    • size: numero, dimensione del messaggio

Eredità

#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()

Proprietà statiche

defaultMaxListeners

Intero, il numero massimo globale predefinito di ascoltatori

1
static Integer DgramSocket.defaultMaxListeners;

Funzione membro

bind

Questo metodo renderà dgram.SocketSpecificato porte in addrascolto sulle informazioni sui pacchetti. Quando l'associazione attiva un listeningevento completo .

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

Parametri di chiamata:

  • port: Intero, specifica il binding della porta, se portnon specificato o è zero, il sistema tenta di associare una porta casuale random
  • addr: Stringa, specificare l'indirizzo di associazione.Se indirizzo non è specificato, il sistema operativo tenterà di ascoltare tutti gli indirizzi.

Questo metodo renderà dgram.SocketIn optsspecificato porte addressascolta le informazioni sui pacchetti. Quando l'associazione attiva un listeningevento completo .

1
DgramSocket.bind(Object opts) async;

Parametri di chiamata:

  • opts: Oggetto, specificare i parametri di associazione

send

Invia un pacchetto sul socket

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

Parametri di chiamata:

  • msg: Buffer, Specificare i dati da inviare
  • port: Intero, specificare la porta di destinazione per l'invio
  • address: Stringa, specifica l'indirizzo di destinazione per l'invio

Risultato di ritorno:

  • Integer, Restituisci dimensioni di invio

Invia un pacchetto sul socket

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

Parametri di chiamata:

  • msg: Buffer, Specificare i dati da inviare
  • offset: Intero, inizia l'invio dall'offset specificato
  • length: Intero, la lunghezza di invio specificata
  • port: Intero, specificare la porta di destinazione per l'invio
  • address: Stringa, specifica l'indirizzo di destinazione per l'invio

Risultato di ritorno:

  • Integer, Restituisci dimensioni di invio

address

Restituisce un oggetto contenente le informazioni sull'indirizzo del socket. Per il socket UDP, questo oggetto conterrà gli attributi di indirizzo, famiglia e porta.

1
NObject DgramSocket.address();

Risultato di ritorno:

  • NObject, Restituire l'indirizzo di associazione dell'oggetto

close

Chiudi la presa corrente

1
DgramSocket.close();

Chiudi la presa corrente

1
DgramSocket.close(Function callback);

Parametri di chiamata:

  • callback: Funzione, si spegne dopo il completamento della funzione di callback, che equivale closeall'aggiunta di un listener di eventi

getRecvBufferSize

Dimensione del buffer di ricezione del socket di query

1
Integer DgramSocket.getRecvBufferSize();

Risultato di ritorno:

  • Integer, Restituisci il risultato della query

getSendBufferSize

Interroga la dimensione del buffer di invio del socket

1
Integer DgramSocket.getSendBufferSize();

Risultato di ritorno:

  • Integer, Restituisci il risultato della query

setRecvBufferSize

Imposta la dimensione del buffer di ricezione del socket

1
DgramSocket.setRecvBufferSize(Integer size);

Parametri di chiamata:

  • size: Intero, specificare la dimensione da impostare

setSendBufferSize

Imposta la dimensione del buffer di invio del socket

1
DgramSocket.setSendBufferSize(Integer size);

Parametri di chiamata:

  • size: Intero, specificare la dimensione da impostare

setBroadcast

Imposta o deseleziona l'opzione socket SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Parametri di chiamata:

  • flag: Boolean, se impostato su true, i pacchetti UDP verranno inviati all'indirizzo di broadcast di un'interfaccia locale

ref

Mantieni l'uscita del processo fibjs e impedisci l'uscita del processo fibjs durante l'associazione degli oggetti

1
DgramSocket DgramSocket.ref();

Risultato di ritorno:

  • DgramSocket, Restituisce l'oggetto corrente

unref

Consenti l'uscita del processo fibjs e l'uscita del processo fibjs durante l'associazione dell'oggetto

1
DgramSocket DgramSocket.unref();

Risultato di ritorno:

  • DgramSocket, Restituisce l'oggetto corrente

on

Associa un gestore di eventi all'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Associa un gestore di eventi all'oggetto

1
Object DgramSocket.on(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto verrà utilizzato come nome dell'evento e il valore della proprietà verrà utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

addListener

Associa un gestore di eventi all'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Associa un gestore di eventi all'oggetto

1
Object DgramSocket.addListener(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto verrà utilizzato come nome dell'evento e il valore della proprietà verrà utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

prependListener

Associa un gestore di eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object DgramSocket.prependListener(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto verrà utilizzato come nome dell'evento e il valore della proprietà verrà utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

once

Associa una funzione di elaborazione dell'evento una tantum all'oggetto, la funzione di elaborazione una tantum verrà attivata solo una volta

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Associa una funzione di elaborazione dell'evento una tantum all'oggetto, la funzione di elaborazione una tantum verrà attivata solo una volta

1
Object DgramSocket.once(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto verrà utilizzato come nome dell'evento e il valore della proprietà verrà utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

prependOnceListener

Associa un gestore di eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object DgramSocket.prependOnceListener(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto verrà utilizzato come nome dell'evento e il valore della proprietà verrà utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

off

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Annulla tutte le funzioni nella coda di elaborazione dell'oggetto

1
Object DgramSocket.off(String ev);

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object DgramSocket.off(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto viene utilizzato come nome dell'evento e il valore della proprietà viene utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

removeListener

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

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

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento
  • func: Funzione, specifica la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Annulla tutte le funzioni nella coda di elaborazione dell'oggetto

1
Object DgramSocket.removeListener(String ev);

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object DgramSocket.removeListener(Object map);

Parametri di chiamata:

  • map: Oggetto, specificare la relazione di mappatura dell'evento, il nome della proprietà dell'oggetto viene utilizzato come nome dell'evento e il valore della proprietà viene utilizzato come funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

removeAllListeners

Annulla tutti i listener di tutti gli eventi dalla coda di elaborazione dell'oggetto.Se viene specificato un evento, rimuovere tutti i listener dell'evento specificato.

1
Object DgramSocket.removeAllListeners(String ev);

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

Annulla tutti i listener di tutti gli eventi dalla coda di elaborazione dell'oggetto.Se viene specificato un evento, rimuovere tutti i listener dell'evento specificato.

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

Parametri di chiamata:

  • evs: Array, specifica il nome dell'evento

Risultato di ritorno:

  • Object, Restituisce l'oggetto evento stesso, che è conveniente per la chiamata a catena

setMaxListeners

Il limite predefinito del numero di ascoltatori, solo per compatibilità

1
DgramSocket.setMaxListeners(Integer n);

Parametri di chiamata:

  • n: Intero, specifica il numero di eventi

getMaxListeners

Ottieni il limite predefinito del numero di ascoltatori, solo per compatibilità

1
Integer DgramSocket.getMaxListeners();

Risultato di ritorno:

  • Integer, Torna al numero limite predefinito

listeners

Array di ascoltatori per l'evento specificato dell'oggetto query

1
Array DgramSocket.listeners(String ev);

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento

Risultato di ritorno:

  • Array, Restituisce un array di ascoltatori per l'evento specificato

listenerCount

Il numero di ascoltatori per l'evento specificato dell'oggetto query

1
Integer DgramSocket.listenerCount(String ev);

Parametri di chiamata:

  • ev: Stringa, specifica il nome dell'evento

Risultato di ritorno:

  • Integer, Restituisce il numero di ascoltatori per l'evento specificato

eventNames

Interroga il nome dell'evento dell'ascoltatore

1
Array DgramSocket.eventNames();

Risultato di ritorno:

  • Array, Restituisce un array di nomi di eventi

emit

Attiva attivamente un evento

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

Parametri di chiamata:

  • ev: Stringa, nome dell'evento
  • args: ..., parametri dell'evento, che verranno passati al gestore dell'evento

Risultato di ritorno:

  • Boolean, Ritorna allo stato di attivazione dell'evento, restituisce true se c'è un evento di risposta, altrimenti restituisce false

toString

Restituisce la rappresentazione in stringa dell'oggetto, generalmente restituisce "[Native Object]", l'oggetto può essere re-implementato secondo le proprie caratteristiche

1
String DgramSocket.toString();

Risultato di ritorno:

  • String, Restituisce la rappresentazione di stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, generalmente restituisce una raccolta di attributi leggibili definiti dall'oggetto

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

Parametri di chiamata:

  • key: Stringa, inutilizzata

Risultato di ritorno:

  • Value, Restituisce un valore contenente JSON serializzabile