Obxecto obxecto incorporado
  1. paxina principal
  2. obxectos incorporados
  3. ObjectDgramSocket

ObjectDgramSocket

dgram.SocketO obxecto é unha función de paquete que encapsula a funciónEventEmitter.

As instancias de DgramSocket son proporcionadas pordgram.createSocket() creada. creardgram.SocketAs instancias non precisan utilizar a nova palabra clave.

Método de creación:

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

evento

DgramSocket herda deEventEmitter, os cambios de estado do obxecto e a recepción de datos impléntanse todos en forma de eventos.

evento pechado

closeO evento activarase despois close()de pechar un usando socket. Unha vez que se active este evento, non se activarán socketnovos eventos nesta páxina.message

evento de erro

Cando se produza algún erro, errordesencadearase o evento.

evento de escoita

Cando un socketcomeza a escoitar a información de paquetes, listeningdesencadearase o evento. Este evento desenvólvese inmediatamente despois de crear o socket UDP.

evento de mensaxe

O evento desenvólvese socketcando se recibe un novo paquete . e pasarase como parámetros á función do controlador de eventos.messagemsgrinfo

  • 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

relación de herdanza

%0 object object toString() toJSON() EventEmitter EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object->EventEmitter DgramSocket DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() addMembership() dropMembership() setMulticastTTL() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref() EventEmitter->DgramSocket

propiedades estáticas

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

función de membro

bind

Este método farádgram.SocketEscoita a información do paquete sobre o especificado porte . addrUn evento desenvólvese cando se completa a vinculación listening.

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

Parámetros de chamada:

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

Este método farádgram.SocketEscoita a información do paquete sobre o optsespecificado porte . addressUn evento desenvólvese cando se completa a vinculación listening.

1
DgramSocket.bind(Object opts) async;

Parámetros de chamada:

  • opts: Obxecto, especifique os parámetros de vinculación

send

Envía un paquete no socket

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

Parámetros de chamada:

  • msg:Buffer, especifique os datos a enviar
  • port: Número enteiro, especifique o porto de destino para enviar
  • address: Cadea, especifique o enderezo de destino para enviar

Resultados de devolución:

  • Integer, devolver o tamaño do envío

Envía un paquete no 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 a enviar
  • offset: Enteiro, comeza a enviar desde o desplazamento especificado
  • length: Enteiro, para enviar a lonxitude especificada
  • port: Número enteiro, especifique o porto de destino para enviar
  • address: Cadea, especifique o enderezo de destino para enviar

Resultados de devolución:

  • Integer, devolver o tamaño do envío

address

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

1
NObject DgramSocket.address();

Resultados de devolución:

  • 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, a función de devolución de chamada despois de que se complete o apagado, o que equivale a closeengadir un oínte para o evento

getRecvBufferSize

Consulta o tamaño do búfer de recepción do socket

1
Integer DgramSocket.getRecvBufferSize();

Resultados de devolución:

  • Integer, devolve os resultados da consulta

getSendBufferSize

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

1
Integer DgramSocket.getSendBufferSize();

Resultados de devolución:

  • Integer, devolve os resultados da consulta

addMembership

Únete ao grupo de multidifusión no multicastAddress e multicastInterface indicados mediante a opción de socket IP_ADD_MEMBERSHIP. Se non se especifica o parámetro multicastInterface, o sistema operativo selecciona unha interface e engade a pertenza a ela. Para engadir subscrición a cada interface dispoñible, chame a addMembership varias veces, unha vez por cada interface.

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

Parámetros de chamada:

  • multicastAddress: Cadea, especifica o enderezo do grupo de multidifusión ao que se unirá
  • multicastInterface: Cadea, especifica a interface do grupo de multidifusión para unirse

dropMembership

Use a opción de socket IP_DROP_MEMBERSHIP para deixar o grupo de multidifusión en multicastAddress. O núcleo chama automaticamente a este método cando se pecha o socket ou o proceso finaliza, polo que a maioría das aplicacións nunca terán motivos para chamar a este método.

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

Parámetros de chamada:

  • multicastAddress: Cadea, especifica o enderezo do grupo de multidifusión que se vai eliminar
  • multicastInterface: Cadea, especifica a interface do grupo de multidifusión que se vai eliminar

setMulticastTTL

Establece a opción de socket IP_MULTICAST_TTL

1
DgramSocket.setMulticastTTL(Integer ttl);

Parámetros de chamada:

  • ttl: Número enteiro, especifica o ttl a configurar, o parámetro ttl pode estar entre 0 e 255. O valor predeterminado na maioría dos sistemas é 1.

setRecvBufferSize

Establecer o tamaño do buffer de recepción do socket

1
DgramSocket.setRecvBufferSize(Integer size);

Parámetros de chamada:

  • size: Número enteiro, especifique o tamaño a definir

setSendBufferSize

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

1
DgramSocket.setSendBufferSize(Integer size);

Parámetros de chamada:

  • size: Número enteiro, especifique o tamaño a definir

setBroadcast

Establece ou borra a opción do 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

Evita que o proceso fibjs saia e evite que o proceso fibjs saia durante a vinculación de obxectos

1
DgramSocket DgramSocket.ref();

Resultados de devolución:

  • DgramSocket, devolve o obxecto actual

unref

Permite que o proceso fibjs saia. Permite que o proceso fibjs saia durante a vinculación de obxectos.

1
DgramSocket DgramSocket.unref();

Resultados de devolución:

  • DgramSocket, devolve o obxecto actual

on

Vincular 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Vincular un controlador de eventos ao obxecto

1
Object DgramSocket.on(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome do atributo do obxecto empregarase como nome do evento e o valor do atributo como función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

addListener

Vincular 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Vincular un controlador de eventos ao obxecto

1
Object DgramSocket.addListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome do atributo do obxecto empregarase como nome do evento e o valor do atributo como función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

prependListener

Vincular un controlador de eventos á orixe 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Vincular un controlador de eventos á orixe do obxecto

1
Object DgramSocket.prependListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome do atributo do obxecto empregarase como nome do evento e o valor do atributo como función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

once

Vincula un controlador de eventos único ao obxecto. O manejador único 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Vincula un controlador de eventos único ao obxecto. O manejador único só se activará unha vez.

1
Object DgramSocket.once(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome do atributo do obxecto empregarase como nome do evento e o valor do atributo como función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

prependOnceListener

Vincular un controlador de eventos á orixe 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Vincular un controlador de eventos á orixe do obxecto

1
Object DgramSocket.prependOnceListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifica a relación de asignación de eventos, o nome do atributo do obxecto empregarase como nome do evento e o valor do atributo como función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

off

Desasignar unha función da 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Cancela 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

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Desasignar unha función da cola de procesamento de obxectos

1
Object DgramSocket.off(Object map);

Parámetros de chamada:

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

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

removeListener

Desasignar unha función da 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, especifique a función de procesamento de eventos

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Cancela 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

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Desasignar unha función da cola de procesamento de obxectos

1
Object DgramSocket.removeListener(Object map);

Parámetros de chamada:

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

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

removeAllListeners

Cancela todos os oíntes de todos os eventos da cola de procesamento do obxecto. Se se especifica un evento, elimina todos os oíntes do evento especificado.

1
Object DgramSocket.removeAllListeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

Cancela todos os oíntes de todos os eventos da cola de procesamento do obxecto. Se se especifica un evento, elimina todos os oíntes do evento especificado.

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

Parámetros de chamada:

  • evs: Matriz, especifique o nome do evento

Resultados de devolución:

  • Object, devolve o propio obxecto do evento para facilitar as chamadas en cadea

setMaxListeners

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

1
DgramSocket.setMaxListeners(Integer n);

Parámetros de chamada:

  • n: Número enteiro, especifique o número de eventos

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

Resultados de devolución:

  • Integer, devolve a cantidade límite predeterminada

listeners

Consulta a matriz de escoita para o evento especificado do obxecto

1
Array DgramSocket.listeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultados de devolución:

  • Array, devolve a matriz de escoita para o evento especificado

listenerCount

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

1
Integer DgramSocket.listenerCount(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultados de devolución:

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

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

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

Resultados de devolución:

  • 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();

Resultados de devolución:

  • Array, devolve unha matriz de nomes de eventos

emit

Activa un evento de forma activa

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

Parámetros de chamada:

  • ev: Cadea, nome do evento
  • args: ..., os parámetros do evento pasaranse á función de procesamento de eventos

Resultados de devolución:

  • Boolean, devolve o estado de activación do evento, devolve verdadeiro se hai un evento de resposta, se non, devolve falso

toString

Devolve a representación en cadea do obxecto. Polo xeral, devólvese "[Obxecto nativo]". O obxecto pódese volver implementar segundo as súas propias características.

1
String DgramSocket.toString();

Resultados de devolución:

  • String, devolve a representación en cadea do obxecto

toJSON

Devolve unha representación en formato JSON do obxecto, devolvendo xeralmente unha colección de propiedades lexibles definidas polo obxecto.

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

Parámetros de chamada:

  • key: Cadena, non usada

Resultados de devolución:

  • Value, devolve un valor que contén JSON serializable
© Copyright 2012-2024 fibjs.org | Apóyanos