ObjectDgramSocket

dgram.SocketL'oggetto è una funzione del pacchetto che incapsula la funzioneEventEmitter.

Le istanze DgramSocket sono fornite dadgram.createSocket() creato. crearedgram.SocketNon è necessario che le istanze utilizzino la nuova parola chiave.

Metodo di creazione:

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

evento

DgramSocket eredita daEventEmitter, i cambiamenti dello stato degli oggetti e la ricezione dei dati sono tutti implementati sotto forma di eventi.

evento vicino

closeL'evento verrà attivato dopo close()averne chiuso uno utilizzando socket. Una volta attivato questo evento, non verranno attivati socketnuovi eventi in questa pagina.message

evento di errore

Quando si verifica un errore, errorl'evento verrà attivato.

evento di ascolto

Quando si socketinizia ad ascoltare le informazioni sui pacchetti, listeningl'evento verrà attivato. Questo evento viene attivato immediatamente dopo la creazione del socket UDP.

evento del messaggio

L'evento viene attivato socketquando viene ricevuto un nuovo pacchetto . e verranno passati come parametri alla funzione del gestore eventi.messagemsgrinfo

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à statiche

defaultMaxListeners

Intero, il numero massimo globale predefinito di ascoltatori

1
static Integer DgramSocket.defaultMaxListeners;

funzione membro

bind

Questo metodo faràdgram.SocketAscoltare le informazioni sul pacchetto sull'oggetto specificato porte . addrUn evento viene generato quando l'associazione è completa listening.

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

Parametri di chiamata:

port: numero intero, specifica la porta di collegamento.Se portnon è specificato o è 0, il sistema operativo tenterà di collegare una porta casuale.
addr: Stringa, specifica l'indirizzo di collegamento.Se l'indirizzo non è specificato, il sistema operativo proverà ad ascoltare tutti gli indirizzi.

Questo metodo faràdgram.SocketAscoltare le informazioni sul pacchetto sull'oggetto specificato optse port. addressUn evento viene generato quando l'associazione è completa listening.

1
DgramSocket.bind(Object opts) async;

Parametri di chiamata:

opts: Oggetto, 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 da inviare
port: Numero intero, specificare la porta di destinazione da inviare
address: Stringa, specifica l'indirizzo di destinazione da inviare

Risultati restituiti:

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, specificare i dati da inviare
offset: Numero intero, inizia l'invio dall'offset specificato
length: Intero, per inviare la lunghezza specificata
port: Numero intero, specificare la porta di destinazione da inviare
address: Stringa, specifica l'indirizzo di destinazione da inviare

Risultati restituiti:

Integer, restituisce la dimensione di invio

address

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

1NObject DgramSocket.address();

Risultati restituiti:

NObject, restituisce l'indirizzo di associazione dell'oggetto

close

Chiudere la presa di corrente

1DgramSocket.close();

Chiudere la presa di corrente

1
DgramSocket.close(Function callback);

Parametri di chiamata:

callback: Funzione, la funzione di callback dopo il completamento dello spegnimento, che equivale ad closeaggiungere un ascoltatore per l'evento

getRecvBufferSize

Interroga la dimensione del buffer di ricezione del socket

1Integer DgramSocket.getRecvBufferSize();

Risultati restituiti:

Integer, restituisce i risultati della query

getSendBufferSize

Interroga la dimensione del buffer di invio del socket

1Integer DgramSocket.getSendBufferSize();

Risultati restituiti:

Integer, restituisce i risultati della query

addMembership

Unisciti al gruppo multicast al multicastAddress e multicastInterface specificati utilizzando l'opzione socket IP_ADD_MEMBERSHIP. Se il parametro multicastInterface non è specificato, il sistema operativo seleziona un'interfaccia e vi aggiunge l'appartenenza. Per aggiungere l'appartenenza a ciascuna interfaccia disponibile, chiamare addMembership più volte, una per ciascuna interfaccia.

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

Parametri di chiamata:

multicastAddress: String, specifica l'indirizzo del gruppo multicast a cui unirsi
multicastInterface: String, specifica l'interfaccia del gruppo multicast a cui unirsi

dropMembership

Utilizzare l'opzione socket IP_DROP_MEMBERSHIP per lasciare il gruppo multicast su multicastAddress. Il kernel chiama automaticamente questo metodo quando il socket viene chiuso o il processo termina, quindi la maggior parte delle applicazioni non avrà mai motivo di chiamare questo metodo.

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

Parametri di chiamata:

multicastAddress: String, specifica l'indirizzo del gruppo multicast da eliminare
multicastInterface: String, specifica l'interfaccia del gruppo multicast da eliminare

setMulticastTTL

Imposta l'opzione socket IP_MULTICAST_TTL

1DgramSocket.setMulticastTTL(Integer ttl);

Parametri di chiamata:

ttl: Intero, specifica il ttl da impostare, il parametro ttl può essere compreso tra 0 e 255. Il valore predefinito sulla maggior parte dei sistemi è 1.

setRecvBufferSize

Imposta la dimensione del buffer di ricezione del socket

1DgramSocket.setRecvBufferSize(Integer size);

Parametri di chiamata:

size: Numero intero, specificare la dimensione da impostare

setSendBufferSize

Imposta la dimensione del buffer di invio del socket

1DgramSocket.setSendBufferSize(Integer size);

Parametri di chiamata:

size: Numero intero, specificare 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 broadcast di un'interfaccia locale

ref

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

1DgramSocket DgramSocket.ref();

Risultati restituiti:

DgramSocket, restituisce l'oggetto corrente

unref

Consenti l'uscita del processo fibjs. Consenti l'uscita del processo fibjs durante l'associazione degli oggetti.

1DgramSocket DgramSocket.unref();

Risultati restituiti:

DgramSocket, restituisce l'oggetto corrente

on

Associa 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: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

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

Associa un gestore eventi all'oggetto

1
Object DgramSocket.on(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

addListener

Associa 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: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

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

Associa un gestore eventi all'oggetto

1
Object DgramSocket.addListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

prependListener

Associa un gestore eventi all'origine 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 dell'evento

Risultati restituiti:

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

Associa un gestore eventi all'origine dell'oggetto

1
Object DgramSocket.prependListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

once

Associa un gestore di eventi monouso all'oggetto. Il gestore di eventi monouso verrà attivato 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 dell'evento

Risultati restituiti:

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

Associa un gestore di eventi monouso all'oggetto. Il gestore di eventi monouso verrà attivato solo una volta.

1
Object DgramSocket.once(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

prependOnceListener

Associa un gestore eventi all'origine 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 dell'evento

Risultati restituiti:

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

Associa un gestore eventi all'origine dell'oggetto

1
Object DgramSocket.prependOnceListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

off

Annullare l'assegnazione di una funzione 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: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare 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, specifica il nome dell'evento

Risultati restituiti:

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

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

1
Object DgramSocket.off(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

removeListener

Annullare l'assegnazione di una funzione 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: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare 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, specifica il nome dell'evento

Risultati restituiti:

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

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

1
Object DgramSocket.removeListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, 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

Risultati restituiti:

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

removeAllListeners

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

1
Object DgramSocket.removeAllListeners(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

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

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

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

Parametri di chiamata:

evs: Array, specifica il nome dell'evento

Risultati restituiti:

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

setMaxListeners

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

1DgramSocket.setMaxListeners(Integer n);

Parametri di chiamata:

n: Numero intero, specifica il numero di eventi

getMaxListeners

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

1Integer DgramSocket.getMaxListeners();

Risultati restituiti:

Integer, restituisce la quantità limite predefinita

listeners

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

1
Array DgramSocket.listeners(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Array, restituisce l'array del 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, specifica il nome dell'evento

Risultati restituiti:

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

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

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

Parametri di chiamata:

o: Valore, specifica l'oggetto della query
ev: String, specifica il nome dell'evento

Risultati restituiti:

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

eventNames

Interroga il nome dell'evento del listener

1
Array DgramSocket.eventNames();

Risultati restituiti:

Array, restituisce una matrice 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: ..., i parametri dell'evento verranno passati alla funzione di elaborazione degli eventi

Risultati restituiti:

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

toString

Restituisce la rappresentazione in formato stringa dell'oggetto. Generalmente viene restituito "[Oggetto nativo]". L'oggetto può essere reimplementato in base alle proprie caratteristiche.

1
String DgramSocket.toString();

Risultati restituiti:

String, restituisce la rappresentazione di stringa dell'oggetto

toJSON

Restituisce una rappresentazione in formato JSON dell'oggetto, generalmente restituendo una raccolta di proprietà leggibili definite dall'oggetto.

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

Parametri di chiamata:

key: Stringa, non utilizzata

Risultati restituiti:

Value, restituisce un valore contenente JSON serializzabile

Guida allo sviluppo

Modulo base

oggetti incorporati

modulo comunitario

ObjectDgramSocket

evento

evento vicino

evento di errore

evento di ascolto

evento del messaggio

rapporto ereditario

proprietà statiche

defaultMaxListeners

funzione membro

bind

send

address

close

getRecvBufferSize

getSendBufferSize

addMembership

dropMembership

setMulticastTTL

setRecvBufferSize

setSendBufferSize

setBroadcast

ref

unref

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON