Objeto objeto incorporado

Objeto DgramSocket

dgram.Socket objeto dgram.Socket es una función de encapsular una funcionalidad EventEmitter paquete EventEmitter .

La instancia de DgramSocket es creada por dgram.createSocket (). dgram.Socket necesario usar la nueva palabra clave para crear dgram.Socket instancia de dgram.Socket .

Método de creación:

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

evento

DgramSocket hereda de EventEmitter . El cambio de estado del objeto y la recepción de datos se implementan en forma de eventos.

evento cercano

close evento de close se activará después de cerrar un socket usando close() . Una vez que se activa este evento, no se activará ningún evento de message nuevo en este socket .

evento de error

Cuando se produce algún error, se activará el evento de error .

evento de escucha

Cuando un socket comienza a escuchar la información del paquete, se activará el evento de listening . Este evento se activará inmediatamente después de crear el socket UDP.

mensaje de evento

Cuando el socket recibe un nuevo paquete, se activará el evento del message . msg y rinfo se pasarán como parámetros al controlador de eventos.

  • msg : Buffer , mensaje
  • rinfo : Objeto, información de dirección remota
    • address : cadena, dirección del remitente
    • family : cadena, tipo de dirección ('IPv4' o 'IPv6')
    • port : número, puerto del remitente
    • size : número, tamaño del mensaje

Herencia

Propiedades estáticas

defaultMaxListeners

Entero, el número máximo global predeterminado de oyentes

1
static Integer DgramSocket.defaultMaxListeners;

Función miembro

bind

Este método hará que dgram.Socket monitoree la información del paquete en el port y addr especificados. Cuando se completa el enlace, se activa un evento de listening .

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

Parámetros de llamada:

  • port : entero, especifique el puerto de enlace, si el port no se especifica o es 0, el sistema operativo intentará vincular un puerto aleatorio
  • addr : String, especifique la dirección de enlace. Si no se especifica la dirección, el sistema operativo intentará escuchar en todas las direcciones.

Este método hará que dgram.Socket monitoree la información del paquete en el port y la address especificada por opts . Cuando se completa el enlace, se activa un evento de listening .

1
DgramSocket.bind(Object opts) async;

Parámetros de llamada:

  • opts : Object, especificar parámetros de enlace

send

Enviar un paquete en el zócalo

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

Parámetros de llamada:

  • msg : Buffer , especifique los datos que se enviarán
  • port : entero, especifique el puerto de destino para enviar
  • address : String, especifique la dirección de destino para enviar

Resultado devuelto:

  • Integer , devuelve el tamaño de envío

Enviar un paquete en el zócalo

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

Parámetros de llamada:

  • msg : Buffer , especifique los datos que se enviarán
  • offset : Integer, comienza a enviar desde el offset especificado
  • length : entero, la longitud especificada de envío
  • port : entero, especifique el puerto de destino para enviar
  • address : String, especifique la dirección de destino para enviar

Resultado devuelto:

  • Integer , devuelve el tamaño de envío

address

Devuelve un objeto que contiene información de la dirección del socket. Para el socket UDP, el objeto contendrá los atributos de dirección, familia y puerto.

1
NObject DgramSocket.address();

Resultado devuelto:

  • NObject , devuelve la dirección de enlace del objeto

close

Cerrar el zócalo actual

1
DgramSocket.close();

Cerrar el zócalo actual

1
DgramSocket.close(Function callback);

Parámetros de llamada:

  • callback : función, la función de devolución de llamada después del cierre, es equivalente a agregar un oyente al evento de close

getRecvBufferSize

Tamaño del búfer de recepción del socket de consulta

1
Integer DgramSocket.getRecvBufferSize();

Resultado devuelto:

  • Integer , resultado de la consulta de devolución

getSendBufferSize

Tamaño del búfer de envío del socket de consulta

1
Integer DgramSocket.getSendBufferSize();

Resultado devuelto:

  • Integer , resultado de la consulta de devolución

setRecvBufferSize

Establecer el tamaño del búfer receptor de socket

1
DgramSocket.setRecvBufferSize(Integer size);

Parámetros de llamada:

  • size : entero, especifique el tamaño que se establecerá

setSendBufferSize

Establecer el tamaño del búfer de envío del socket

1
DgramSocket.setSendBufferSize(Integer size);

Parámetros de llamada:

  • size : entero, especifique el tamaño que se establecerá

setBroadcast

Establecer o borrar la opción de socket SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Parámetros de llamada:

  • flag : Boolean, cuando se establece en true, los paquetes UDP se enviarán a la dirección de difusión de una interfaz local

ref

Evite que el proceso fibjs salga y evite que el proceso fibjs salga durante la unión del objeto

1
DgramSocket DgramSocket.ref();

Resultado devuelto:

  • DgramSocket , devuelve el objeto actual

unref

Permita que el proceso fibjs salga y permita que el proceso fibjs salga durante el enlace del objeto

1
DgramSocket DgramSocket.unref();

Resultado devuelto:

  • DgramSocket , devuelve el objeto actual

on

Vincula un controlador de eventos al objeto

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al objeto

1
Object DgramSocket.on(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

addListener

Vincula un controlador de eventos al objeto

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al objeto

1
Object DgramSocket.addListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

prependListener

Vincula un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

once

Vincula una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

1
Object DgramSocket.once(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

prependOnceListener

Vincula un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Vincula un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto será el nombre del evento y el valor de la propiedad será la función de procesamiento del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

off

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.off(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object DgramSocket.off(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

removeListener

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev : String, especifique el nombre del evento
  • func : Function, especifica la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(Object map);

Parámetros de llamada:

  • map : Object, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

removeAllListeners

Cancele todos los oyentes de todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todos los oyentes del evento especificado.

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

Parámetros de llamada:

  • evs : matriz, especifique el nombre del evento

Resultado devuelto:

  • Object , devuelve el objeto del evento en sí mismo, fácil de encadenar

setMaxListeners

El límite predeterminado del número de oyentes, solo por compatibilidad

1
DgramSocket.setMaxListeners(Integer n);

Parámetros de llamada:

  • n : entero, especifique el número de eventos

getMaxListeners

Obtenga el límite predeterminado de la cantidad de oyentes, solo por compatibilidad

1
Integer DgramSocket.getMaxListeners();

Resultado devuelto:

  • Integer , devuelve el número límite predeterminado

listeners

Matriz de oyentes para el evento especificado del objeto de consulta

1
Array DgramSocket.listeners(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Array , devuelve una matriz de oyentes para el evento especificado

listenerCount

El número de oyentes para el evento especificado del objeto de consulta

1
Integer DgramSocket.listenerCount(String ev);

Parámetros de llamada:

  • ev : String, especifique el nombre del evento

Resultado devuelto:

  • Integer , devuelve el número de oyentes para el evento especificado

eventNames

Nombre del evento del oyente de consultas

1
Array DgramSocket.eventNames();

Resultado devuelto:

  • Array , devuelve una matriz de nombres de eventos

emit

Activar activamente un evento

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

Parámetros de llamada:

  • ev : String, nombre del evento
  • args : ..., parámetros de evento, que se pasarán al controlador de eventos

Resultado devuelto:

  • Boolean , devuelve el estado desencadenante del evento, devuelve verdadero si hay un evento de respuesta, de lo contrario devuelve falso

toString

Devuelve la representación de cadena del objeto, generalmente devuelve "[Objeto nativo]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String DgramSocket.toString();

Resultado devuelto:

  • String , devuelve la representación de cadena del objeto

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

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

Parámetros de llamada:

  • key : cadena, sin usar

Resultado devuelto:

  • Value , devuelve un valor que contiene JSON serializable