Obxecto incorporado

Obxecto DgramSocket

dgram.Socket O obxecto é un paquete que encapsula a función do paquete de datos EventEmitter.

A instancia de DgramSocket é creada por dgram.createSocket() Creado. creardgram.Socket A instancia non precisa empregar a nova palabra clave.

Método de creación:

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

evento

DgramSocket herdado de EventEmitter, O cambio de estado do obxecto e a aceptación de datos realízanse en forma de eventos.

evento próximo

closeOs eventos utilizaranse close()para pechar un socketdisparador despois. O evento Unha vez activado, socketnon desencadeará un novo messageevento.

evento de erro

Cando se produce algún erro, o errorevento activarase.

evento de escoita

Cando socketcomece a escoitar información de paquetes, listeningo evento activarase. Este evento activarase inmediatamente despois de crear o socket UDP.

evento de mensaxe

Cando se socketrecibe un novo paquete , o messageevento activarase. msgE rinfopasouse ao controlador de eventos como parámetro.

  • msg: Buffer, información
  • rinfo: Obxecto, información de enderezo remoto
    • address: cadea, enderezo do remitente
    • family: cadea, tipo de enderezo ('IPv4' ou 'IPv6')
    • port: número, porto do remitente
    • size: número, tamaño da mensaxe

Herdanza

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

Propiedades estáticas

defaultMaxListeners

Entero, o número máximo predeterminado global de oíntes

1
static Integer DgramSocket.defaultMaxListeners;

Función de membro

bind

Este método fará dgram.SocketEspecificar porte addrescoitar información de paquetes. Cando a vinculación provoca un listeningevento completo .

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

Parámetros de chamada:

  • port: Enteiro, especifica a vinculación do porto, se portnon se especifica ou é cero, o sistema tenta ligar un porto aleatorio
  • addr: Cadea, especifica o enderezo de vinculación. Se non se especifica o enderezo, o sistema operativo tentará escoitar todos os enderezos.

Este método fará dgram.SocketEn optsespecificado porte addressescoitar información de paquetes. Cando a vinculación provoca un listeningevento completo .

1
DgramSocket.bind(Object opts) async;

Parámetros de chamada:

  • opts: Obxecto, especifica os parámetros de conexión

send

Envía un paquete ao socket

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

Parámetros de chamada:

  • msg: Buffer, Especifique os datos que se van enviar
  • port: Enteiro, especifique o porto de destino para o envío
  • address: Cadea, especifique o enderezo de destino para o envío

Resultado de volta:

  • Integer, Devolver o tamaño de envío

Envía un paquete ao socket

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

Parámetros de chamada:

  • msg: Buffer, Especifique os datos que se van enviar
  • offset: Enteiro, comeza a enviar desde o desprazamento especificado
  • length: Enteiro, a duración de envío especificada
  • port: Enteiro, especifique o porto de destino para o envío
  • address: Cadea, especifique o enderezo de destino para o envío

Resultado de volta:

  • Integer, Devolver o tamaño de envío

address

Devolve un obxecto que contén información de enderezo de socket. Para o socket UDP, este obxecto conterá atributos de enderezo, familia e porto.

1
NObject DgramSocket.address();

Resultado de volta:

  • NObject, Devolve o enderezo de vinculación do obxecto

close

Pecha o socket actual

1
DgramSocket.close();

Pecha o socket actual

1
DgramSocket.close(Function callback);

Parámetros de chamada:

  • callback: Función, pechada despois de completar a función de devolución de chamada, o que equivale a closeengadir un oínte de eventos

getRecvBufferSize

Socket de consulta que recibe o tamaño do búfer

1
Integer DgramSocket.getRecvBufferSize();

Resultado de volta:

  • Integer, Devolve o resultado da consulta

getSendBufferSize

Consulte o tamaño do búfer de envío de sockets

1
Integer DgramSocket.getSendBufferSize();

Resultado de volta:

  • Integer, Devolve o resultado da consulta

setRecvBufferSize

Estableza o tamaño do búfer que recibe o socket

1
DgramSocket.setRecvBufferSize(Integer size);

Parámetros de chamada:

  • size: Enteiro, especifique o tamaño que se vai definir

setSendBufferSize

Estableza o tamaño do búfer de envío de socket

1
DgramSocket.setSendBufferSize(Integer size);

Parámetros de chamada:

  • size: Enteiro, especifique o tamaño que se vai definir

setBroadcast

Estableza ou elimina a opción de socket SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Parámetros de chamada:

  • flag: Booleano, cando se define como verdadeiro, os paquetes UDP enviaranse ao enderezo de difusión dunha interface local

ref

Evite que o proceso fibjs saia e evite que o proceso fibjs saia durante a unión de obxectos

1
DgramSocket DgramSocket.ref();

Resultado de volta:

  • DgramSocket, Devolve o obxecto actual

unref

Permitir a saída do proceso fibjs e permitir a saída do proceso fibjs durante a unión de obxectos

1
DgramSocket DgramSocket.unref();

Resultado de volta:

  • DgramSocket, Devolve o obxecto actual

on

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object DgramSocket.on(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

addListener

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object DgramSocket.addListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object DgramSocket.prependListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

once

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

1
Object DgramSocket.once(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependOnceListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

off

Cancelar a función especificada desde a cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións da cola de procesamento de obxectos

1
Object DgramSocket.off(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada desde a cola de procesamento de obxectos

1
Object DgramSocket.off(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeListener

Cancelar a función especificada desde a cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións da cola de procesamento de obxectos

1
Object DgramSocket.removeListener(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada desde a cola de procesamento de obxectos

1
Object DgramSocket.removeListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeAllListeners

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

1
Object DgramSocket.removeAllListeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

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

Parámetros de chamada:

  • evs: Matriz, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

setMaxListeners

O límite predeterminado do número de oíntes, só para compatibilidade

1
DgramSocket.setMaxListeners(Integer n);

Parámetros de chamada:

  • n: Enteiro, especifique o número de eventos

getMaxListeners

Obtén o límite predeterminado do número de oíntes, só por compatibilidade

1
Integer DgramSocket.getMaxListeners();

Resultado de volta:

  • Integer, Volver ao número límite predeterminado

listeners

Matriz de oíntes para o evento especificado do obxecto de consulta

1
Array DgramSocket.listeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Array, Devolve unha matriz de oíntes para o evento especificado

listenerCount

O número de oíntes para o evento especificado do obxecto de consulta

1
Integer DgramSocket.listenerCount(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Integer, Devolve o número de oíntes para o evento especificado

O número de oíntes para o evento especificado do obxecto de consulta

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

Parámetros de chamada:

  • o: Valor, especifica o obxecto da consulta
  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Integer, Devolve o número de oíntes para o evento especificado

eventNames

Consulta o nome do evento do oínte

1
Array DgramSocket.eventNames();

Resultado de volta:

  • Array, Devolve unha matriz de nomes de eventos

emit

Desencadea un evento activamente

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

Parámetros de chamada:

  • ev: Cadea, nome do evento
  • args: ..., parámetros do evento, que se pasarán ao controlador de eventos

Resultado de volta:

  • Boolean, Volver ao estado de activación do evento, devolver verdadeiro se hai un evento de resposta, en caso contrario devolver falso

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String DgramSocket.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable