Objeto objeto incorporado

Objeto DgramSocket

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

Las instancias de DgramSocket son creadas por dgram.createSocket (). dgram.Socket necesita utilizar la nueva palabra clave para crear una instancia de dgram.Socket .

Crear método:

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

Suceso

DgramSocket hereda de EventEmitter , el cambio de estado del objeto y la aceptación de datos se implementan en forma de eventos.

evento cercano

close evento de close se activará después de que socket cierre un socket utilizando 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 desencadena inmediatamente después de que se crea el socket UDP.

mensaje de evento

Cuando el socket recibe un nuevo paquete, se activa el evento de message . msg y rinfo se pasan como parámetros a la función del controlador del evento.

  • 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

Propiedad estática

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 la especificada port y addr paquete de información del monitor. 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, especifica el puerto de enlace. Si el port no se especifica o es 0, el sistema operativo intentará vincular un puerto aleatorio
  • addr : String, especifica 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 escuche 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 a enviar
  • port : entero, especifique el puerto de destino para enviar
  • address : String, especifique la dirección de destino para enviar

Devuelve el resultado:

  • Integer , tamaño de envío de devolución

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 a enviar
  • offset : entero, enviar desde el offset especificado
  • length : entero, envía la longitud especificada
  • port : entero, especifique el puerto de destino para enviar
  • address : String, especifique la dirección de destino para enviar

Devuelve el resultado:

  • Integer , tamaño de envío de devolución

address

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

1
NObject DgramSocket.address();

Devuelve el resultado:

  • NObject , dirección de enlace del objeto devuelto

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, función de devolución de llamada después de completar el cierre, es equivalente a agregar un escucha para el evento de close

getRecvBufferSize

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

1
Integer DgramSocket.getRecvBufferSize();

Devuelve el resultado:

  • Integer , devuelve resultados de la consulta

getSendBufferSize

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

1
Integer DgramSocket.getSendBufferSize();

Devuelve el resultado:

  • Integer , devuelve resultados de la consulta

setRecvBufferSize

Establecer el tamaño del buffer 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 : 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();

Devuelve el resultado:

  • DgramSocket , devuelve el objeto actual

unref

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

1
DgramSocket DgramSocket.unref();

Devuelve el resultado:

  • DgramSocket , devuelve el objeto actual

on

Vincula un controlador de eventos a un objeto

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

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos a un objeto

1
Object DgramSocket.on(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

addListener

Vincula un controlador de eventos a un objeto

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

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Vincula un controlador de eventos a un objeto

1
Object DgramSocket.addListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

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, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

once

Enlace un controlador de eventos de una sola vez al objeto. El controlador de una sola vez solo se disparará una vez.

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

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Enlace un controlador de eventos de una sola vez al objeto. El controlador de una sola vez solo se disparará una vez.

1
Object DgramSocket.once(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

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, el nombre del evento especificado
  • func : Function, especifica la función del controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

Vincula un controlador de eventos al inicio del objeto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map : Object, especifica la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como el controlador de eventos

Devuelve el resultado:

  • Object , devuelve el número de enlaces exitosos, o 0 si la función está enlazada

off

Función no especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.off(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Función no especificada de la cola de procesamiento de objetos

1
Object DgramSocket.off(Object map);

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

removeListener

Función no especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

Función no especificada de la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(Object map);

Parámetros de llamada:

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

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

removeAllListeners

Cancele todos los escuchas para todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todas las escuchas para el evento especificado.

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

Parámetros de llamada:

  • evs : matriz, especifique el nombre del evento

Devuelve el resultado:

  • Object , devuelve el objeto de evento en sí, lo cual es conveniente para llamadas encadenadas

setMaxListeners

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

1
DgramSocket.setMaxListeners(Integer n);

Parámetros de llamada:

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

getMaxListeners

Obtenga el número límite predeterminado de oyentes, solo por compatibilidad

1
Integer DgramSocket.getMaxListeners();

Devuelve el resultado:

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

listeners

La matriz de escucha para el evento especificado del objeto de consulta

1
Array DgramSocket.listeners(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

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

listenerCount

Consulta el número de oyentes para el evento especificado

1
Integer DgramSocket.listenerCount(String ev);

Parámetros de llamada:

  • ev : String, el nombre del evento especificado

Devuelve el resultado:

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

eventNames

Nombre del evento del oyente de consultas

1
Array DgramSocket.eventNames();

Devuelve el 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 : ..., los parámetros del evento se pasarán al controlador de eventos

Devuelve el 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 una representación de cadena del objeto, generalmente "[Objeto nativo]". Los objetos se pueden volver a implementar de acuerdo con sus propias características

1
String DgramSocket.toString();

Devuelve el resultado:

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

toJSON

Devuelve una representación JSON del objeto, que generalmente devuelve una colección de propiedades legibles definidas por el objeto

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

Parámetros de llamada:

  • key : cadena, sin usar

Devuelve el resultado:

  • Value , devuelve un valor que contiene un JSON serializable