Objekt integriertes Objekt

ObjectDgramSocket

dgram.SocketDas Objekt ist eine Paketfunktion, die die Funktion kapseltEventEmitter.

DgramSocket-Instanzen werden bereitgestellt vondgram.createSocket() erstellt. erstellendgram.SocketInstanzen müssen das neue Schlüsselwort nicht verwenden.

Erstellungsmethode:

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

Ereignis

DgramSocket erbt vonEventEmitter, Objektzustandsänderungen und Datenempfang werden alle in Form von Ereignissen implementiert.

Ereignis schließen

closeDas Ereignis wird nach close()dem Schließen eines Ereignisses mit ausgelöst socket. Sobald dieses Ereignis ausgelöst wird, werden auf dieser Seite socketkeine neuen Ereignisse ausgelöst.message

Fehlerereignis

Wenn ein Fehler auftritt, errorwird das Ereignis ausgelöst.

Hörereignis

Wenn man socketbeginnt, auf Paketinformationen zu warten, listeningwird das Ereignis ausgelöst. Dieses Ereignis wird unmittelbar nach der Erstellung des UDP-Sockets ausgelöst.

Nachrichtenereignis

Das Ereignis wird ausgelöst socket, wenn ein neues Paket empfangen wird . und werden als Parameter an die Event-Handler-Funktion übergeben.messagemsgrinfo

  • msg:Buffer,Information
  • rinfo: Objekt, Remote-Adressinformationen
    • address: Zeichenfolge, Absenderadresse
    • family: Zeichenfolge, Adresstyp („IPv4“ oder „IPv6“)
    • port: Nummer, Absenderport
    • size: Anzahl, Nachrichtengröße

Erbschaftsverhältnis

statische Eigenschaften

defaultMaxListeners

Ganzzahl, die standardmäßige globale maximale Anzahl von Listenern

1
static Integer DgramSocket.defaultMaxListeners;

Mitgliedsfunktion

bind

Diese Methode wird es schaffendgram.SocketAchten Sie auf Paketinformationen zu den angegebenen portund . addrEin Ereignis wird ausgelöst, wenn die Bindung abgeschlossen ist listening.

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

Aufrufparameter:

  • port: Ganzzahl, gibt den Bindungsport an. Wenn er portnicht angegeben ist oder 0 ist, versucht das Betriebssystem, einen zufälligen Port zu binden.
  • addr: Zeichenfolge, gibt die Bindungsadresse an. Wenn die Adresse nicht angegeben ist, versucht das Betriebssystem, alle Adressen abzuhören.

Diese Methode wird es schaffendgram.SocketAchten Sie auf Paketinformationen zu den optsangegebenen portund . addressEin Ereignis wird ausgelöst, wenn die Bindung abgeschlossen ist listening.

1
DgramSocket.bind(Object opts) async;

Aufrufparameter:

  • opts: Objekt, Bindungsparameter angeben

send

Senden Sie ein Paket an den Socket

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

Aufrufparameter:

  • msg:BufferGeben Sie die zu sendenden Daten an
  • port: Ganzzahl, geben Sie den zu sendenden Zielport an
  • address: Zeichenfolge, geben Sie die zu sendende Zieladresse an

Rückgabeergebnisse:

  • Integer, Sendegröße zurücksenden

Senden Sie ein Paket an den Socket

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

Aufrufparameter:

  • msg:BufferGeben Sie die zu sendenden Daten an
  • offset: Ganzzahl, beginnen Sie mit dem Senden ab dem angegebenen Offset
  • length: Ganzzahl, um die angegebene Länge zu senden
  • port: Ganzzahl, geben Sie den zu sendenden Zielport an
  • address: Zeichenfolge, geben Sie die zu sendende Zieladresse an

Rückgabeergebnisse:

  • Integer, Sendegröße zurücksenden

address

Gibt ein Objekt zurück, das Socket-Adressinformationen enthält. Bei UDP-Sockets enthält das Objekt Adress-, Familien- und Porteigenschaften.

1
NObject DgramSocket.address();

Rückgabeergebnisse:

  • NObject, gibt die Objektbindungsadresse zurück

close

Schließen Sie die aktuelle Steckdose

1
DgramSocket.close();

Schließen Sie die aktuelle Steckdose

1
DgramSocket.close(Function callback);

Aufrufparameter:

  • callback: Funktion, die Rückruffunktion nach Abschluss des Herunterfahrens, was dem closeHinzufügen eines Listeners für das Ereignis entspricht

getRecvBufferSize

Fragen Sie die Größe des Socket-Empfangspuffers ab

1
Integer DgramSocket.getRecvBufferSize();

Rückgabeergebnisse:

  • Integer, Abfrageergebnisse zurückgeben

getSendBufferSize

Fragen Sie die Größe des Socket-Sendepuffers ab

1
Integer DgramSocket.getSendBufferSize();

Rückgabeergebnisse:

  • Integer, Abfrageergebnisse zurückgeben

addMembership

Treten Sie der Multicast-Gruppe unter der angegebenen multicastAddress und multicastInterface bei, indem Sie die Socket-Option IP_ADD_MEMBERSHIP verwenden. Wenn der Parameter multicastInterface nicht angegeben ist, wählt das Betriebssystem eine Schnittstelle aus und fügt ihr eine Mitgliedschaft hinzu. Um jeder verfügbaren Schnittstelle eine Mitgliedschaft hinzuzufügen, rufen Sie addMembership mehrmals auf, einmal für jede Schnittstelle.

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

Aufrufparameter:

  • multicastAddress: String, gibt die Multicast-Gruppenadresse an, der beigetreten werden soll
  • multicastInterface: String, gibt die Multicast-Gruppenschnittstelle an, der beigetreten werden soll

dropMembership

Verwenden Sie die Socket-Option IP_DROP_MEMBERSHIP, um die Multicast-Gruppe bei multicastAddress zu belassen. Der Kernel ruft diese Methode automatisch auf, wenn der Socket geschlossen oder der Prozess beendet wird, sodass die meisten Anwendungen nie einen Grund haben, diese Methode aufzurufen.

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

Aufrufparameter:

  • multicastAddress: String, gibt die zu löschende Multicast-Gruppenadresse an
  • multicastInterface: String, gibt die zu löschende Multicast-Gruppenschnittstelle an

setMulticastTTL

Legen Sie die Socket-Option IP_MULTICAST_TTL fest

1
DgramSocket.setMulticastTTL(Integer ttl);

Aufrufparameter:

  • ttl: Ganzzahl, gibt den festzulegenden TTL an. Der TTL-Parameter kann zwischen 0 und 255 liegen. Der Standardwert ist auf den meisten Systemen 1.

setRecvBufferSize

Legen Sie die Größe des Socket-Empfangspuffers fest

1
DgramSocket.setRecvBufferSize(Integer size);

Aufrufparameter:

  • size: Ganzzahl, geben Sie die festzulegende Größe an

setSendBufferSize

Legen Sie die Größe des Socket-Sendepuffers fest

1
DgramSocket.setSendBufferSize(Integer size);

Aufrufparameter:

  • size: Ganzzahl, geben Sie die festzulegende Größe an

setBroadcast

Legen Sie die Socket-Option SO_BROADCAST fest oder löschen Sie sie

1
DgramSocket.setBroadcast(Boolean flag);

Aufrufparameter:

  • flag: Boolean, wenn auf true gesetzt, werden UDP-Pakete an die Broadcast-Adresse einer lokalen Schnittstelle gesendet

ref

Verhindern Sie, dass der fibjs-Prozess beendet wird, und verhindern Sie, dass der fibjs-Prozess während der Objektbindung beendet wird

1
DgramSocket DgramSocket.ref();

Rückgabeergebnisse:

  • DgramSocket, gibt das aktuelle Objekt zurück

unref

Beenden des fibjs-Prozesses zulassen. Ermöglichen, dass der fibjs-Prozess während der Objektbindung beendet wird.

1
DgramSocket DgramSocket.unref();

Rückgabeergebnisse:

  • DgramSocket, gibt das aktuelle Objekt zurück

on

Binden Sie einen Event-Handler an das Objekt

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Binden Sie einen Event-Handler an das Objekt

1
Object DgramSocket.on(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

addListener

Binden Sie einen Event-Handler an das Objekt

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Binden Sie einen Event-Handler an das Objekt

1
Object DgramSocket.addListener(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

prependListener

Binden Sie einen Ereignishandler an den Ursprung des Objekts

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Binden Sie einen Ereignishandler an den Ursprung des Objekts

1
Object DgramSocket.prependListener(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

once

Binden Sie einen einmaligen Ereignishandler an das Objekt. Der einmalige Handler wird nur einmal ausgelöst.

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Binden Sie einen einmaligen Ereignishandler an das Objekt. Der einmalige Handler wird nur einmal ausgelöst.

1
Object DgramSocket.once(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

prependOnceListener

Binden Sie einen Ereignishandler an den Ursprung des Objekts

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Binden Sie einen Ereignishandler an den Ursprung des Objekts

1
Object DgramSocket.prependOnceListener(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

off

Heben Sie die Zuweisung einer Funktion zur Objektverarbeitungswarteschlange auf

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.off(String ev);

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Heben Sie die Zuweisung einer Funktion zur Objektverarbeitungswarteschlange auf

1
Object DgramSocket.off(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

removeListener

Heben Sie die Zuweisung einer Funktion zur Objektverarbeitungswarteschlange auf

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

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an
  • func: Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.removeListener(String ev);

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Heben Sie die Zuweisung einer Funktion zur Objektverarbeitungswarteschlange auf

1
Object DgramSocket.removeListener(Object map);

Aufrufparameter:

  • map: Objekt, gibt die Ereigniszuordnungsbeziehung an, der Objektattributname wird als Ereignisname und der Wert des Attributs als Ereignisverarbeitungsfunktion verwendet

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

removeAllListeners

Löscht alle Listener für alle Ereignisse aus der Verarbeitungswarteschlange des Objekts. Wenn ein Ereignis angegeben ist, werden alle Listener für das angegebene Ereignis entfernt.

1
Object DgramSocket.removeAllListeners(String ev);

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

Löscht alle Listener für alle Ereignisse aus der Verarbeitungswarteschlange des Objekts. Wenn ein Ereignis angegeben ist, werden alle Listener für das angegebene Ereignis entfernt.

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

Aufrufparameter:

  • evs: Array, geben Sie den Namen des Ereignisses an

Rückgabeergebnisse:

  • Object, gibt das Ereignisobjekt selbst zurück, um Kettenaufrufe zu erleichtern

setMaxListeners

Die Standardbeschränkung für die Anzahl der Listener dient nur der Kompatibilität

1
DgramSocket.setMaxListeners(Integer n);

Aufrufparameter:

  • n: Ganzzahl, geben Sie die Anzahl der Ereignisse an

getMaxListeners

Ruft nur aus Kompatibilitätsgründen die standardmäßige maximale Anzahl von Listenern ab

1
Integer DgramSocket.getMaxListeners();

Rückgabeergebnisse:

  • Integer, gibt die Standardgrenzmenge zurück

listeners

Fragen Sie das Listener-Array nach dem angegebenen Ereignis des Objekts ab

1
Array DgramSocket.listeners(String ev);

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Array, gibt das Listener-Array für das angegebene Ereignis zurück

listenerCount

Fragen Sie die Anzahl der Listener für das angegebene Ereignis des Objekts ab

1
Integer DgramSocket.listenerCount(String ev);

Aufrufparameter:

  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Integer, gibt die Anzahl der Listener für das angegebene Ereignis zurück

Fragen Sie die Anzahl der Listener für das angegebene Ereignis des Objekts ab

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

Aufrufparameter:

  • o: Wert, gibt das Objekt der Abfrage an
  • ev: String, gibt den Namen des Ereignisses an

Rückgabeergebnisse:

  • Integer, gibt die Anzahl der Listener für das angegebene Ereignis zurück

eventNames

Name des Abfrage-Listener-Ereignisses

1
Array DgramSocket.eventNames();

Rückgabeergebnisse:

  • Array, gibt ein Array von Ereignisnamen zurück

emit

Ein Ereignis aktiv auslösen

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

Aufrufparameter:

  • ev: String, Ereignisname
  • args: ..., Ereignisparameter werden an die Ereignisverarbeitungsfunktion übergeben

Rückgabeergebnisse:

  • Boolean, gibt den Ereignisauslöserstatus zurück, gibt „true“ zurück, wenn ein Antwortereignis vorliegt, andernfalls wird „false“ zurückgegeben

toString

Gibt die Zeichenfolgendarstellung des Objekts zurück. Im Allgemeinen wird „[Native Object]“ zurückgegeben. Das Objekt kann gemäß seinen eigenen Eigenschaften neu implementiert werden.

1
String DgramSocket.toString();

Rückgabeergebnisse:

  • String, gibt die Zeichenfolgendarstellung des Objekts zurück

toJSON

Gibt eine Darstellung des Objekts im JSON-Format zurück und gibt im Allgemeinen eine Sammlung lesbarer Eigenschaften zurück, die vom Objekt definiert werden.

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

Aufrufparameter:

  • key: Zeichenfolge, nicht verwendet

Rückgabeergebnisse:

  • Value, gibt einen Wert zurück, der JSON serialisierbar enthält