Oggetto oggetto incorporato

Oggetto DgramSocket

dgram.SocketL'oggetto è un pacchetto che incapsula la funzionalità della funzione pacchettoEventEmitter.

Le istanze di DgramSocket sono create dadgram.createSocket() creato. crearedgram.SocketLe istanze non devono utilizzare la nuova parola chiave.

Metodo di creazione:

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

evento

DgramSocket eredita daEventEmitter, Il cambio di stato dell'oggetto e l'accettazione dei dati sono tutti implementati sotto forma di eventi.

chiudere l'evento

closeL'evento verrà attivato dopo close()la chiusura di a con a socket. Una volta attivato questo evento socket, nessun nuovo messageevento verrà attivato su questo.

evento di errore

errorL'evento verrà generato quando si verifica un errore .

evento di ascolto

L'evento verrà attivato quando a socketinizia ad ascoltare le informazioni sui pacchetti. listeningQuesto evento viene generato immediatamente dopo la creazione del socket UDP.

evento del messaggio

Quando viene socketricevuto , messagel'evento verrà attivato. msge rinfoverranno passati come parametri al gestore eventi.

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

rapporto ereditario

proprietà statica

defaultMaxListeners

Integer, il numero massimo globale predefinito di listener

1
static Integer DgramSocket.defaultMaxListeners;

funzione membro

bind

Questo metodo faràdgram.SocketAscolta le informazioni sul pacchetto sull'oggetto specificato porte . addrUn listeningevento .

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

Parametri di chiamata:

  • port: Integer, specifica la porta di associazione, se portnon specificato o 0, il sistema operativo tenterà di associare una porta casuale
  • addr: String, specifica l'indirizzo di associazione, se l'indirizzo non è specificato, il sistema operativo proverà ad ascoltare tutti gli indirizzi.

Questo metodo faràdgram.SocketAscolta le informazioni sui pacchetti su e optsspecificate da . Un evento .portaddresslistening

1
DgramSocket.bind(Object opts) async;

Parametri di chiamata:

  • opts: Oggetto, specifica i parametri di associazione

send

Invia un pacchetto sulla presa

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

Parametri di chiamata:

  • msg:Buffer, specifica i dati da inviare
  • port: Numero intero, specifica la porta di destinazione per l'invio
  • address: String, specifica l'indirizzo di destinazione da inviare

risultato di ritorno:

  • Integer, restituisce la dimensione di invio

Invia un pacchetto sulla presa

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

Parametri di chiamata:

  • msg:Buffer, specifica i dati da inviare
  • offset: numero intero, avvia l'invio dall'offset specificato
  • length: Integer, la lunghezza specificata per l'invio
  • port: Numero intero, specifica la porta di destinazione per l'invio
  • address: String, specifica l'indirizzo di destinazione da inviare

risultato di ritorno:

  • Integer, restituisce la dimensione di invio

address

Restituisce un oggetto contenente informazioni sull'indirizzo del socket. Per i socket UDP, questo oggetto conterrà le proprietà dell'indirizzo, della famiglia e della porta.

1
NObject DgramSocket.address();

risultato di ritorno:

  • NObject, restituisce l'indirizzo di binding dell'oggetto

close

chiudere la presa di corrente

1
DgramSocket.close();

chiudere la presa di corrente

1
DgramSocket.close(Function callback);

Parametri di chiamata:

  • callback: Function, la funzione di callback dopo la chiusura è completata, che equivale ad aggiungere un listener closeall'evento

getRecvBufferSize

Il socket di query riceve la dimensione del buffer

1
Integer DgramSocket.getRecvBufferSize();

risultato di ritorno:

  • Integer, restituisce il risultato della query

getSendBufferSize

Interroga la dimensione del buffer di invio del socket

1
Integer DgramSocket.getSendBufferSize();

risultato di ritorno:

  • Integer, restituisce il risultato della query

setRecvBufferSize

Imposta la dimensione del buffer di ricezione del socket

1
DgramSocket.setRecvBufferSize(Integer size);

Parametri di chiamata:

  • size: Integer, specifica la dimensione da impostare

setSendBufferSize

Imposta la dimensione del buffer di invio del socket

1
DgramSocket.setSendBufferSize(Integer size);

Parametri di chiamata:

  • size: Integer, specifica la dimensione da impostare

setBroadcast

Impostare o deselezionare 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 dell'oggetto

1
DgramSocket DgramSocket.ref();

risultato di ritorno:

  • DgramSocket, restituisce l'oggetto corrente

unref

Consentire al processo fibjs di uscire, consentire al processo fibjs di uscire durante l'associazione dell'oggetto

1
DgramSocket DgramSocket.unref();

risultato di ritorno:

  • DgramSocket, restituisce l'oggetto corrente

on

Associa un gestore di eventi a un oggetto

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Associa un gestore di eventi a un oggetto

1
Object DgramSocket.on(Object map);

Parametri di chiamata:

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

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

addListener

Associa un gestore di eventi a un oggetto

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Associa un gestore di eventi a un oggetto

1
Object DgramSocket.addListener(Object map);

Parametri di chiamata:

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

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

prependListener

Associa una funzione del gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Associa una funzione del gestore eventi all'inizio dell'oggetto

1
Object DgramSocket.prependListener(Object map);

Parametri di chiamata:

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

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

once

Associa un gestore di eventi monouso all'oggetto, il gestore monouso verrà attivato solo una volta

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Associa un gestore di eventi monouso all'oggetto, il gestore monouso verrà attivato solo una volta

1
Object DgramSocket.once(Object map);

Parametri di chiamata:

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

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

prependOnceListener

Associa una funzione del gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Associa una funzione del gestore eventi all'inizio dell'oggetto

1
Object DgramSocket.prependOnceListener(Object map);

Parametri di chiamata:

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

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

off

funzione unspecify dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object DgramSocket.off(String ev);

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

funzione unspecify dalla coda di elaborazione degli oggetti

1
Object DgramSocket.off(Object map);

Parametri di chiamata:

  • map: Object, specifica la relazione di mappatura dell'evento, il nome dell'attributo dell'oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione dell'evento

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

removeListener

funzione unspecify dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato
  • func: Funzione, specifica la funzione del gestore eventi

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object DgramSocket.removeListener(String ev);

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

funzione unspecify dalla coda di elaborazione degli oggetti

1
Object DgramSocket.removeListener(Object map);

Parametri di chiamata:

  • map: Object, specifica la relazione di mappatura dell'evento, il nome dell'attributo dell'oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione dell'evento

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

removeAllListeners

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione dell'oggetto o rimuove tutti i listener per l'evento specificato se è specificato un evento.

1
Object DgramSocket.removeAllListeners(String ev);

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione dell'oggetto o rimuove tutti i listener per l'evento specificato se è specificato un evento.

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

Parametri di chiamata:

  • evs: Array, il nome dell'evento specificato

risultato di ritorno:

  • Object, restituisce l'oggetto evento stesso, utile per le chiamate a catena

setMaxListeners

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

1
DgramSocket.setMaxListeners(Integer n);

Parametri di chiamata:

  • n: Integer, specifica il numero di eventi

getMaxListeners

Ottiene il numero limitato predefinito di listener, solo per compatibilità

1
Integer DgramSocket.getMaxListeners();

risultato di ritorno:

  • Integer, restituisce il numero limite predefinito

listeners

Interroga l'array di listener per l'evento specificato dell'oggetto

1
Array DgramSocket.listeners(String ev);

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato

risultato di ritorno:

  • Array, restituisce una matrice di listener per l'evento specificato

listenerCount

Interroga il numero di ascoltatori per l'evento specificato dell'oggetto

1
Integer DgramSocket.listenerCount(String ev);

Parametri di chiamata:

  • ev: String, il nome dell'evento specificato

risultato di ritorno:

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

Interroga il numero di ascoltatori per l'evento specificato dell'oggetto

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

Parametri di chiamata:

  • o: Value, specifica l'oggetto della query
  • ev: String, il nome dell'evento specificato

risultato di ritorno:

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

eventNames

Interroga il nome dell'evento del listener

1
Array DgramSocket.eventNames();

risultato di ritorno:

  • Array, restituisce una matrice di nomi di eventi

emit

Attivare attivamente un evento

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

Parametri di chiamata:

  • ev: stringa, nome dell'evento
  • args: ..., i parametri dell'evento, verranno passati alla funzione del gestore dell'evento

risultato di ritorno:

  • Boolean, restituisce lo stato di attivazione dell'evento, restituisce true se è presente un evento di risposta, altrimenti restituisce false

toString

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

1
String DgramSocket.toString();

risultato di ritorno:

  • String, restituisce una rappresentazione in forma di stringa dell'oggetto

toJSON

Restituisce la rappresentazione in formato JSON dell'oggetto, in genere restituisce una raccolta di proprietà leggibili definite dall'oggetto

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

Parametri di chiamata:

  • key: stringa, non utilizzata

risultato di ritorno:

  • Value, che restituisce un valore serializzabile in JSON