Oggetto oggetto incorporato

Oggetto DgramSocket

dgram.Socket oggetto dgram.Socket è una funzione che incapsula una funzionalità EventEmitter pacchetto EventEmitter .

L'istanza DgramSocket viene creata da dgram.createSocket (). dgram.Socket necessario utilizzare la nuova parola chiave per creare un'istanza di dgram.Socket .

Metodo di creazione:

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 sono tutti implementati sotto forma di eventi.

evento vicino

close evento close verrà attivato dopo aver chiuso un socket utilizzando close() . Una volta che questo evento è stato attivato, 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, viene attivato l'evento di listening . Questo evento verrà attivato immediatamente dopo la creazione del socket UDP.

evento messaggio

Quando un nuovo pacchetto viene ricevuto dal socket , verrà attivato l'evento di message . msg e rinfo verranno passati come parametri al gestore di 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 mittente
    • size : numero, dimensione del messaggio

Eredità

Proprietà statiche

defaultMaxListeners

Integer, il numero massimo globale predefinito di listener

1
static Integer DgramSocket.defaultMaxListeners;

Funzione membro

bind

Questo metodo farà in modo che dgram.Socket controlli le informazioni sui pacchetti sulla port e addr specificati. Quando l'associazione è completa, 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 proverà a collegare una porta casuale
  • addr : String, specifica l'indirizzo di binding.Se address non è specificato, il sistema operativo proverà ad ascoltare tutti gli indirizzi.

Questo metodo farà in modo che dgram.Socket ascolti le informazioni sui pacchetti sulla port e l' address specificati da opts . Quando l'associazione è completa, 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 , specifica i dati da inviare
  • port : numero intero, specifica la porta di destinazione per l'invio
  • address : stringa, specifica l'indirizzo di destinazione da inviare

Risultato di ritorno:

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

Risultato di ritorno:

  • Integer , restituisce la dimensione 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 , restituisce l'indirizzo di associazione 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, equivale ad aggiungere un listener all'evento close

getRecvBufferSize

Query socket che riceve la dimensione del buffer

1
Integer DgramSocket.getRecvBufferSize();

Risultato di ritorno:

  • Integer , restituisce il risultato della query

getSendBufferSize

Dimensione del buffer di invio del socket della query

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

Imposta o deseleziona 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

Evita che il processo fibjs esca e impedisce l'uscita del processo fibjs durante l'associazione di oggetti

1
DgramSocket DgramSocket.ref();

Risultato di ritorno:

  • DgramSocket , restituisce l'oggetto corrente

unref

Consentire al processo fibjs di uscire e consentire al processo fibjs di uscire durante l'associazione degli oggetti

1
DgramSocket DgramSocket.unref();

Risultato di ritorno:

  • DgramSocket , restituisce l'oggetto corrente

on

Associare un gestore di eventi all'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associare un gestore di eventi all'oggetto

1
Object DgramSocket.on(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

addListener

Associare un gestore di eventi all'oggetto

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

Parametri di chiamata:

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

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associare un gestore di eventi all'oggetto

1
Object DgramSocket.addListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare 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 : String, specifica il nome dell'evento
  • func : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object DgramSocket.prependListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

once

Associa una funzione di elaborazione di eventi 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 : String, specifica il nome dell'evento
  • func : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa una funzione di elaborazione di eventi 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 : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare 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 : String, specifica il nome dell'evento
  • func : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

Associa un gestore di eventi all'inizio dell'oggetto

1
Object DgramSocket.prependOnceListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione della mappatura degli eventi, il nome della proprietà dell'oggetto sarà il nome dell'evento e il valore della proprietà sarà la funzione di elaborazione dell'evento

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare 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 : String, specifica il nome dell'evento
  • func : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

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, facile da chiamare a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object DgramSocket.off(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura degli eventi, 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, facile da chiamare 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 : String, specifica il nome dell'evento
  • func : funzione, specifica la funzione di elaborazione degli eventi

Risultato di ritorno:

  • Object , restituisce l'oggetto evento stesso, facile da chiamare a catena

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, facile da chiamare a catena

Annulla la funzione specificata dalla coda di elaborazione dell'oggetto

1
Object DgramSocket.removeListener(Object map);

Parametri di chiamata:

  • map : Object, specifica la relazione di mappatura degli eventi, 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, facile da chiamare a catena

removeAllListeners

Annulla tutti i listener di tutti gli eventi dalla coda di elaborazione degli oggetti. 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, facile da chiamare a catena

setMaxListeners

Il limite predefinito del numero di listener, 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 listener, solo per compatibilità

1
Integer DgramSocket.getMaxListeners();

Risultato di ritorno:

  • 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

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

1
Integer DgramSocket.listenerCount(String ev);

Parametri di chiamata:

  • ev : String, specifica il nome dell'evento

Risultato di ritorno:

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

eventNames

Nome dell'evento del listener di query

1
Array DgramSocket.eventNames();

Risultato di ritorno:

  • Array , restituisce un array di nomi di eventi

emit

Attiva un evento attivamente

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

Parametri di chiamata:

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

Risultato di ritorno:

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

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 la rappresentazione in formato 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, non utilizzata

Risultato di ritorno:

  • Value , restituisce un valore contenente JSON serializzabile