Oggetto oggetto incorporato

Oggetto DgramSocket

dgram.Socket oggetto dgram.Socket è una funzione dell'incapsulamento di una funzionalità EventEmitter pacchetto EventEmitter .

L'istanza DgramSocket è creata da dgram.createSocket (). La nuova parola chiave non è richiesta per creare istanze di dgram.Socket .

Come creare:

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

evento

DgramSocket eredita da EventEmitter , il cambio di stato dell'oggetto e la ricezione dei dati vengono implementati sotto forma di eventi.

evento vicino

close evento di close verrà attivato dopo aver chiuso un socket usando close() . Una volta attivato questo evento, nessun nuovo evento di message verrà attivato su questo socket .

evento di errore

Quando si verifica un error , verrà attivato l'evento di error .

evento di ascolto

Quando un socket inizia ad ascoltare le informazioni sui pacchetti, verrà attivato l'evento di listening . Questo evento verrà attivato immediatamente dopo la creazione del socket UDP.

evento del messaggio

Quando un nuovo pacchetto di dati viene ricevuto dal socket , verrà attivato l'evento del message . msg e rinfo verranno passati come parametri alla funzione di elaborazione degli eventi.

  • msg : Buffer , messaggio
  • 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

Eredità

Proprietà statica

defaultMaxListeners

Numero intero, numero massimo globale predefinito di listener

1
static Integer DgramSocket.defaultMaxListeners;

Funzione membro

bind

Questo metodo farà sì che dgram.Socket ascolti le informazioni sul pacchetto sulla port specificata e su addr . Al termine listening , viene attivato un evento di listening .

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

Parametri di chiamata:

  • port : numero intero, specificare la porta di associazione, se la port non port specificata 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 su tutti gli indirizzi.

Questo metodo farà sì che dgram.Socket ascolti le informazioni sui pacchetti sulla port e address specificati da opts . Al termine listening , viene attivato un evento di listening .

1
DgramSocket.bind(Object opts) async;

Parametri di chiamata:

  • opts : Object, specifica 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 inviati
  • port : numero intero, specificare la porta di destinazione per l'invio
  • address : stringa, specificare l'indirizzo di destinazione da inviare

Risultato di ritorno:

  • Integer , restituisce dimensione 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 inviati
  • offset : intero, inizia a inviare dall'offset specificato
  • length : numero intero, invia la lunghezza specificata
  • port : numero intero, specificare la porta di destinazione per l'invio
  • address : stringa, specificare l'indirizzo di destinazione da inviare

Risultato di ritorno:

  • Integer , restituisce dimensione di invio

address

Restituisce un oggetto contenente informazioni sull'indirizzo socket. Per il socket UDP, questo oggetto conterrà gli indirizzi, la famiglia e gli attributi della porta.

1
NObject DgramSocket.address();

Risultato di ritorno:

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

close

Chiude il socket corrente

1
DgramSocket.close();

Chiude il socket corrente

1
DgramSocket.close(Function callback);

Parametri di chiamata:

  • callback : Function, la funzione callback al termine della chiusura, equivale ad aggiungere un listener per l'evento close

getRecvBufferSize

Interroga la dimensione del buffer di ricezione del socket

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 : numero intero, specifica la dimensione da impostare

setSendBufferSize

Imposta la dimensione del buffer di invio socket

1
DgramSocket.setSendBufferSize(Integer size);

Parametri di chiamata:

  • size : numero intero, specifica la dimensione da impostare

setBroadcast

Impostare o deselezionare l'opzione socket SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Parametri di chiamata:

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

ref

Impedisci al processo fibjs di uscire e impedisce al processo fibjs di uscire durante l'associazione degli oggetti

1
DgramSocket DgramSocket.ref();

Risultato di ritorno:

  • DgramSocket , restituisce l'oggetto corrente

unref

Consentire l'uscita del processo fibjs e consentire l'uscita del processo fibjs durante l'associazione degli oggetti

1
DgramSocket DgramSocket.unref();

Risultato di ritorno:

  • DgramSocket , restituisce l'oggetto corrente

on

Associare un gestore eventi all'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'oggetto

1
Object DgramSocket.on(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

addListener

Associare un gestore eventi all'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'oggetto

1
Object DgramSocket.addListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

prependListener

Associare un gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'inizio dell'oggetto

1
Object DgramSocket.prependListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

once

Associa un gestore eventi singolo all'oggetto, il gestore singolo si attiverà una sola volta

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associa un gestore eventi singolo all'oggetto, il gestore singolo si attiverà una sola volta

1
Object DgramSocket.once(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

prependOnceListener

Associare un gestore eventi all'inizio dell'oggetto

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Associare un gestore eventi all'inizio dell'oggetto

1
Object DgramSocket.prependOnceListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mapping degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come gestore dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

off

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object DgramSocket.off(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

1
Object DgramSocket.off(Object map);

Parametri di chiamata:

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

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

removeListener

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento
  • func : Function, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object DgramSocket.removeListener(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

Annulla la funzione specificata dalla coda di elaborazione degli oggetti

1
Object DgramSocket.removeListener(Object map);

Parametri di chiamata:

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

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, che è conveniente per le chiamate concatenate

removeAllListeners

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione degli oggetti Se specificato, rimuove tutti i listener per gli eventi specificati.

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 le chiamate concatenate

setMaxListeners

Il numero limite predefinito di ascoltatori, solo per compatibilità

1
DgramSocket.setMaxListeners(Integer n);

Parametri di chiamata:

  • n : intero, specifica il numero di eventi

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

Risultato di ritorno:

  • Numero Integer , restituisce il numero limite predefinito

listeners

Matrice di listener per l'evento specificato dell'oggetto query

1
Array DgramSocket.listeners(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

  • Array , restituisce un array di listener per l'evento specificato

listenerCount

Interroga il numero di listener per l'evento specificato

1
Integer DgramSocket.listenerCount(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

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

eventNames

Nome dell'evento listener query

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 : String, nome dell'evento
  • args : ..., i parametri dell'evento, saranno passati alla funzione del gestore eventi

Risultato di ritorno:

  • Boolean , restituisce lo stato di attivazione dell'evento, restituisce vero se c'è un evento di risposta, altrimenti restituisce falso

toString

Restituisce la rappresentazione in forma di stringa dell'oggetto, in genere restituisce "[Native Object]", l'oggetto può essere reimplementato in base alle proprie caratteristiche

1
String DgramSocket.toString();

Risultato di ritorno:

  • String , restituisce una rappresentazione in formato stringa dell'oggetto

toJSON

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

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

Parametri di chiamata:

  • key : stringa, non utilizzata

Risultato di ritorno:

  • Value , restituisce un valore contenente serializzabile JSON