Objeto objeto integrado

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 (). La nueva palabra clave no es necesaria 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 realizan 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 ocurre cualquier 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 que se cree el socket UDP.

evento de mensaje

Cuando el socket recibe un nuevo paquete, se activa el evento de 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 supervisar la información del paquete especificado en el port y addr . 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á enlazar un puerto aleatorio
  • addr : String, especifique la dirección de enlace. Si no se especifica la dirección, el sistema operativo intentará escuchar todas las direcciones.

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

1
DgramSocket.bind(Object opts) async;

Parámetros de llamada:

  • opts : Objeto, especificar parámetros de enlace

send

Envía un paquete en el socket

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 : Cadena, especifique la dirección de destino para enviar

Devolver resultado:

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

Envía un paquete en el socket

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 : entero, 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 : Cadena, especifique la dirección de destino para enviar

Devolver resultado:

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

address

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

1
NObject DgramSocket.address();

Devolver resultado:

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

close

Cerrar el enchufe actual

1
DgramSocket.close();

Cerrar el enchufe 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();

Devolver resultado:

  • Integer , devuelve el resultado de la consulta

getSendBufferSize

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

1
Integer DgramSocket.getSendBufferSize();

Devolver resultado:

  • Integer , devuelve el resultado de la consulta

setRecvBufferSize

Establecer el tamaño del búfer de recepción del 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 : booleano, cuando se establece en verdadero, los paquetes UDP se enviarán a la dirección de transmisión de una interfaz local

ref

Evite que el proceso de fibjs salga y evite que el proceso de fibjs salga durante la vinculación de objetos

1
DgramSocket DgramSocket.ref();

Devolver resultado:

  • DgramSocket , devuelve el objeto actual

unref

Permita que el proceso de fibjs salga y permita que el proceso de fibjs salga durante la vinculación de objetos

1
DgramSocket DgramSocket.unref();

Devolver resultado:

  • DgramSocket , devuelve el objeto actual

on

Vincular un controlador de eventos al objeto

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

Parámetros de llamada:

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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Vincular un controlador de eventos al objeto

1
Object DgramSocket.on(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

addListener

Vincular un controlador de eventos al objeto

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

Parámetros de llamada:

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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Vincular un controlador de eventos al objeto

1
Object DgramSocket.addListener(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

prependListener

Vincular un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Vincular un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependListener(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

once

Vincular un controlador de eventos único al objeto, el controlador único solo se activará una vez

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

Parámetros de llamada:

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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Vincular un controlador de eventos único al objeto, el controlador único solo se activará una vez

1
Object DgramSocket.once(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

prependOnceListener

Vincular un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Vincular un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

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, especifica el nombre del evento
  • func : función, especificar función de procesamiento de eventos

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.off(String ev);

Parámetros de llamada:

  • ev : String, especifica el nombre del evento

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

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

1
Object DgramSocket.off(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

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, especifica el nombre del evento
  • func : función, especificar función de procesamiento de eventos

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(String ev);

Parámetros de llamada:

  • ev : String, especifica el nombre del evento

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

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

1
Object DgramSocket.removeListener(Object map);

Parámetros de llamada:

  • map : Objeto, 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

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

removeAllListeners

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

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

Parámetros de llamada:

  • evs : Array, especifica el nombre del evento

Devolver resultado:

  • Object , devuelve el objeto del evento en sí, fácil de llamar en cadena

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 del número de oyentes, solo por compatibilidad

1
Integer DgramSocket.getMaxListeners();

Devolver resultado:

  • 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, especifica el nombre del evento

Devolver resultado:

  • 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, especifica el nombre del evento

Devolver resultado:

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

eventNames

Nombre del evento de escucha de consultas

1
Array DgramSocket.eventNames();

Devolver resultado:

  • 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

Devolver resultado:

  • Boolean , devuelve el estado de activación 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();

Devolver resultado:

  • 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 : String, sin usar

Devolver resultado:

  • Value , devuelve un valor que contiene JSON serializable