Objeto incorporado

ObjetoDgramSocket

dgram.SocketEl objeto es una función de paquete que encapsula la función.EventEmitter.

Las instancias de DgramSocket son proporcionadas pordgram.createSocket() creado. creardgram.SocketNo es necesario que las instancias utilicen la nueva palabra clave.

Método de creación:

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

evento

DgramSocket hereda deEventEmitter, los cambios de estado de los objetos y la recepción de datos se implementan en forma de eventos.

cerrar evento

closeEl evento se activará después de close()cerrar uno usando socket. Una vez que se activa este evento, no se activarán socketnuevos eventos en esta página.message

evento de error

Cuando ocurra algún error, errorse activará el evento.

evento de escucha

Cuando uno socketcomienza a escuchar la información del paquete, listeningse activará el evento. Este evento se activa inmediatamente después de que se crea el socket UDP.

evento de mensaje

El evento se activa socketcuando se recibe un nuevo paquete . y se pasarán como parámetros a la función del controlador de eventos.messagemsgrinfo

  • msg:Buffer,información
  • 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

relación de 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ádgram.SocketEscuche la información del paquete en el especificado porty . addrSe activa un evento cuando se completa el enlace listening.

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

Parámetros de llamada:

  • port: Entero, especifica el puerto de enlace. Si portno se especifica o es 0, el sistema operativo intentará enlazar un puerto aleatorio.
  • addr: Cadena, 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ádgram.SocketEscuche la información del paquete en el optsespecificado porty . addressSe activa un evento cuando se completa el enlace listening.

1
DgramSocket.bind(Object opts) async;

Parámetros de llamada:

  • opts: Objeto, especificar parámetros de enlace

send

Enviar un paquete en el socket

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

Parámetros de llamada:

  • msg:Buffer, especifica los datos a enviar
  • port: Entero, especifique el puerto de destino para enviar
  • address: Cadena, especifica la dirección de destino a enviar

Resultados de devolución:

  • Integer, devolver tamaño de envío

Enviar 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, especifica los datos a enviar
  • offset: Entero, comienza a enviar desde el desplazamiento especificado
  • length: Entero, para enviar la longitud especificada
  • port: Entero, especifique el puerto de destino para enviar
  • address: Cadena, especifica la dirección de destino a enviar

Resultados de devolución:

  • Integer, devolver tamaño de envío

address

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

1
NObject DgramSocket.address();

Resultados de devolución:

  • 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 de que se completa el apagado, lo que equivale a closeagregar un oyente para el evento

getRecvBufferSize

Consultar el tamaño del búfer de recepción del socket

1
Integer DgramSocket.getRecvBufferSize();

Resultados de devolución:

  • Integer, devolver resultados de la consulta

getSendBufferSize

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

1
Integer DgramSocket.getSendBufferSize();

Resultados de devolución:

  • Integer, devolver resultados de la consulta

addMembership

Únase al grupo de multidifusión en la dirección de multidifusión y la interfaz de multidifusión proporcionadas utilizando la opción de socket IP_ADD_MEMBERSHIP. Si no se especifica el parámetro multicastInterface, el sistema operativo selecciona una interfaz y le agrega membresía. Para agregar membresía a cada interfaz disponible, llame a addMembership varias veces, una vez para cada interfaz.

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

Parámetros de llamada:

  • multicastAddress: Cadena, especifica la dirección del grupo de multidifusión al que unirse
  • multicastInterface: Cadena, especifica la interfaz del grupo de multidifusión al que unirse

dropMembership

Utilice la opción de socket IP_DROP_MEMBERSHIP para dejar el grupo de multidifusión en multicastAddress. El kernel llama automáticamente a este método cuando se cierra el socket o el proceso finaliza, por lo que la mayoría de las aplicaciones nunca tendrán una razón para llamar a este método.

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

Parámetros de llamada:

  • multicastAddress: Cadena, especifica la dirección del grupo de multidifusión que se eliminará
  • multicastInterface: Cadena, especifica la interfaz del grupo de multidifusión que se eliminará

setMulticastTTL

Establecer la opción de conector IP_MULTICAST_TTL

1
DgramSocket.setMulticastTTL(Integer ttl);

Parámetros de llamada:

  • ttl: Entero, especifica el ttl que se establecerá, el parámetro ttl puede estar entre 0 y 255. El valor predeterminado en la mayoría de los sistemas es 1.

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 fibjs salga y evite que el proceso fibjs salga durante el enlace de objetos

1
DgramSocket DgramSocket.ref();

Resultados de devolución:

  • DgramSocket, devuelve el objeto actual

unref

Permitir que el proceso fibjs salga.Permitir que el proceso fibjs salga durante el enlace del objeto.

1
DgramSocket DgramSocket.unref();

Resultados de devolución:

  • 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: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Vincular un controlador de eventos al objeto

1
Object DgramSocket.on(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usará como nombre del evento y el valor del atributo se usará como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

addListener

Vincular un controlador de eventos al objeto

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Vincular un controlador de eventos al objeto

1
Object DgramSocket.addListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usará como nombre del evento y el valor del atributo se usará como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

prependListener

Vincular un controlador de eventos al origen del objeto

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Vincular un controlador de eventos al origen del objeto

1
Object DgramSocket.prependListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usará como nombre del evento y el valor del atributo se usará como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

once

Vincula un controlador de eventos de una sola vez al objeto. El controlador de eventos de una sola vez solo se activará una vez.

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Vincula un controlador de eventos de una sola vez al objeto. El controlador de eventos de una sola vez solo se activará una vez.

1
Object DgramSocket.once(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usará como nombre del evento y el valor del atributo se usará como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

prependOnceListener

Vincular un controlador de eventos al origen del objeto

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Vincular un controlador de eventos al origen del objeto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usará como nombre del evento y el valor del atributo se usará como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

off

Desasignar una función de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.off(String ev);

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Desasignar una función de la cola de procesamiento de objetos

1
Object DgramSocket.off(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usa como nombre del evento y el valor del atributo se usa como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

removeListener

Desasignar una función de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.
  • func: Función, especifique la función de procesamiento de eventos

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(String ev);

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Desasignar una función de la cola de procesamiento de objetos

1
Object DgramSocket.removeListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifica la relación de mapeo de eventos, el nombre del atributo del objeto se usa como nombre del evento y el valor del atributo se usa como función de procesamiento de eventos.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

removeAllListeners

Cancela todos los oyentes de todos los eventos de la cola de procesamiento del objeto. Si se especifica un evento, elimina todos los oyentes del evento especificado.

1
Object DgramSocket.removeAllListeners(String ev);

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

Cancela todos los oyentes de todos los eventos de la cola de procesamiento del objeto. Si se especifica un evento, elimina todos los oyentes del evento especificado.

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

Parámetros de llamada:

  • evs: Matriz, especifique el nombre del evento

Resultados de devolución:

  • Object, devuelve el objeto de evento en sí para facilitar las llamadas en cadena

setMaxListeners

El límite predeterminado en la cantidad de oyentes, solo por compatibilidad

1
DgramSocket.setMaxListeners(Integer n);

Parámetros de llamada:

  • n: Entero, especifica el número de eventos

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

Resultados de devolución:

  • Integer, devuelve la cantidad límite predeterminada

listeners

Consultar la matriz de escucha para el evento especificado del objeto.

1
Array DgramSocket.listeners(String ev);

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

  • Array, devuelve la matriz de escucha para el evento especificado

listenerCount

Consultar el número de oyentes para el evento especificado del objeto.

1
Integer DgramSocket.listenerCount(String ev);

Parámetros de llamada:

  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

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

Consultar el número de oyentes para el evento especificado del objeto.

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

Parámetros de llamada:

  • o: Valor, especifica el objeto de la consulta.
  • ev: Cadena, especifica el nombre del evento.

Resultados de devolución:

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

eventNames

Nombre del evento del oyente de consultas

1
Array DgramSocket.eventNames();

Resultados de devolución:

  • Array, devuelve una serie de nombres de eventos

emit

Activar activamente un evento

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

Parámetros de llamada:

  • ev: Cadena, nombre del evento
  • args: ..., los parámetros del evento se pasarán a la función de procesamiento de eventos

Resultados de devolución:

  • Boolean, devuelve el estado del activador 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, se devuelve "[Objeto nativo]". El objeto se puede volver a implementar de acuerdo con sus propias características.

1
String DgramSocket.toString();

Resultados de devolución:

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

toJSON

Devuelve una representación en formato 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, no utilizada

Resultados de devolución:

  • Value, devuelve un valor que contiene JSON serializable