Objekt eingebautes Objekt

Objekt DgramSocket

dgram.Socket Das Objekt ist ein Paket, das die Funktion des Datenpakets kapselt EventEmitter.

Die DgramSocket-Instanz wird erstellt von dgram.createSocket() Erstellt. schaffendgram.Socket Die Instanz muss das neue Schlüsselwort nicht verwenden.

Erstellungsmethode:

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

Veranstaltung

DgramSocket geerbt von EventEmitter, Die Zustandsänderung des Objekts und die Datenübernahme werden in Form von Ereignissen realisiert.

Veranstaltung schließen

closeEreignisse werden verwendet close(), um einen socketTrigger danach zu schließen . Das Ereignis Einmal ausgelöst, löst dies socketkein neues messageEreignis aus.

Fehlerereignis

Wenn ein Fehler auftritt, wird das errorEreignis ausgelöst.

Hörereignis

Beim socketStart des Abhörens von Paketinformationen wird listeningdas Ereignis ausgelöst. Dieses Ereignis wird sofort nach dem Erstellen des UDP-Sockets ausgelöst.

Nachrichtenereignis

Wenn ein neues Paket socketempfangen wird, wird das messageEreignis ausgelöst. msgUnd rinfoals Parameter an den Event-Handler übergeben.

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

Nachlass

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>DgramSocket|bind();send();address();close();getRecvBufferSize();getSendBufferSize();setRecvBufferSize();setSendBufferSize();setBroadcast();ref();unref()] [object] <:- [EventEmitter] [EventEmitter] <:- [DgramSocket] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object toString() toJSON() DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref()

Statische Eigenschaften

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

Mitgliederfunktion

bind

Diese Methode macht dgram.SocketSpezifiziert portund addrhört auf Paketinformationen. Wenn die Bindung ein vollständiges listeningEreignis auslöst .

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

Aufrufparameter:

  • port: Integer, gibt die Portbindung an, wenn portnicht angegeben oder null ist, versucht das System, einen zufälligen Port zu binden
  • addr: String, geben Sie die Bindungsadresse an.Wenn die Adresse nicht angegeben ist, versucht das Betriebssystem, alle Adressen abzuhören.

Diese Methode macht dgram.SocketIn optsangegeben portund addressauf Paketinformationen hören. Wenn die Bindung ein vollständiges listeningEreignis auslöst .

1
DgramSocket.bind(Object opts) async;

Aufrufparameter:

  • opts: Objekt, Bindungsparameter angeben

send

Senden Sie ein Paket an die Steckdose

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

Aufrufparameter:

  • msg: Buffer, Geben Sie die zu sendenden Daten an
  • port: Integer, geben Sie den Zielport zum Senden an
  • address: String, geben Sie die Zieladresse für den Versand an

Ergebnis zurückgeben:

  • Integer, senden größe zurück

Senden Sie ein Paket an die Steckdose

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

Aufrufparameter:

  • msg: Buffer, Geben Sie die zu sendenden Daten an
  • offset: Integer, Sendebeginn ab dem angegebenen Offset
  • length: Integer, die angegebene Sendelänge
  • port: Integer, geben Sie den Zielport zum Senden an
  • address: String, geben Sie die Zieladresse für den Versand an

Ergebnis zurückgeben:

  • Integer, senden größe zurück

address

Gibt ein Objekt mit Socket-Adressinformationen zurück. Für UDP-Socket enthält dieses Objekt Adress-, Familien- und Portattribute.

1
NObject DgramSocket.address();

Ergebnis zurückgeben:

  • NObject, Geben Sie 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, wird nach Abschluss der Callback-Funktion heruntergefahren, was dem closeHinzufügen eines Ereignis-Listeners entspricht

getRecvBufferSize

Query-Socket-Empfangspuffergröße

1
Integer DgramSocket.getRecvBufferSize();

Ergebnis zurückgeben:

  • Integer, Abfrageergebnis zurückgeben

getSendBufferSize

Abfrage der Größe des Socket-Sendepuffers

1
Integer DgramSocket.getSendBufferSize();

Ergebnis zurückgeben:

  • Integer, Abfrageergebnis zurückgeben

setRecvBufferSize

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

1
DgramSocket.setRecvBufferSize(Integer size);

Aufrufparameter:

  • size: Integer, geben Sie die einzustellende Größe an

setSendBufferSize

Legen Sie die Socket-Sendepuffergröße fest

1
DgramSocket.setSendBufferSize(Integer size);

Aufrufparameter:

  • size: Integer, geben Sie die einzustellende Größe an

setBroadcast

Setzen oder löschen Sie die Socket-Option SO_BROADCAST

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

Ergebnis zurückgeben:

  • DgramSocket, Gibt das aktuelle Objekt zurück

unref

Erlauben Sie dem fibjs-Prozess das Beenden und dem Fibjs-Prozess das Beenden während der Objektbindung

1
DgramSocket DgramSocket.unref();

Ergebnis zurückgeben:

  • DgramSocket, Gibt das aktuelle Objekt zurück

on

Binden Sie einen Ereignishandler an das Objekt

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an das Objekt

1
Object DgramSocket.on(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

addListener

Binden Sie einen Ereignishandler an das Objekt

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an das Objekt

1
Object DgramSocket.addListener(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

prependListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object DgramSocket.prependListener(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

once

Binden Sie eine einmalige Ereignisverarbeitungsfunktion an das Objekt, die einmalige Verarbeitungsfunktion wird nur einmal ausgelöst

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie eine einmalige Ereignisverarbeitungsfunktion an das Objekt, die einmalige Verarbeitungsfunktion wird nur einmal ausgelöst

1
Object DgramSocket.once(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

prependOnceListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object DgramSocket.prependOnceListener(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

off

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Alle Funktionen in der Objektverarbeitungswarteschlange abbrechen

1
Object DgramSocket.off(String ev);

Aufrufparameter:

  • ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.off(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

removeListener

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Alle Funktionen in der Objektverarbeitungswarteschlange abbrechen

1
Object DgramSocket.removeListener(String ev);

Aufrufparameter:

  • ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.removeListener(Object map);

Aufrufparameter:

  • map: Objekt, geben Sie die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

removeAllListeners

Abbrechen aller Listener aller Ereignisse aus der Objektverarbeitungswarteschlange Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener des angegebenen Ereignisses.

1
Object DgramSocket.removeAllListeners(String ev);

Aufrufparameter:

  • ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

Abbrechen aller Listener aller Ereignisse aus der Objektverarbeitungswarteschlange Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener des angegebenen Ereignisses.

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

Aufrufparameter:

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

Ergebnis zurückgeben:

  • Object, Geben Sie das Ereignisobjekt selbst zurück, was für Kettenaufrufe praktisch ist

setMaxListeners

Die Standardbegrenzung der Anzahl der Listener, nur aus Kompatibilitätsgründen

1
DgramSocket.setMaxListeners(Integer n);

Aufrufparameter:

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

getMaxListeners

Holen Sie sich das Standardlimit für die Anzahl der Listener, nur aus Kompatibilitätsgründen

1
Integer DgramSocket.getMaxListeners();

Ergebnis zurückgeben:

  • Integer, Zurück zur Standardgrenzzahl

listeners

Array von Listenern für das angegebene Ereignis des Abfrageobjekts

1
Array DgramSocket.listeners(String ev);

Aufrufparameter:

  • ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

  • Array, Gibt ein Array von Listenern für das angegebene Ereignis zurück

listenerCount

Die Anzahl der Listener für das angegebene Ereignis des Abfrageobjekts

1
Integer DgramSocket.listenerCount(String ev);

Aufrufparameter:

  • ev: String, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

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

Die Anzahl der Listener für das angegebene Ereignis des Abfrageobjekts

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

Aufrufparameter:

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

Ergebnis zurückgeben:

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

eventNames

Abfrage des Ereignisnamens des Listeners

1
Array DgramSocket.eventNames();

Ergebnis zurückgeben:

  • 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: ..., Event-Parameter, die an den Event-Handler übergeben werden

Ergebnis zurückgeben:

  • Boolean, Rückkehr zum Ereignis-Trigger-Zustand, true zurückgeben, wenn ein Antwortereignis vorliegt, andernfalls false zurückgeben

toString

Gibt die String-Darstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück, das Objekt kann entsprechend seiner eigenen Eigenschaften neu implementiert werden

1
String DgramSocket.toString();

Ergebnis zurückgeben:

  • String, Gibt die String-Darstellung des Objekts zurück

toJSON

Gibt die Darstellung des Objekts im JSON-Format zurück, gibt im Allgemeinen eine Sammlung von lesbaren Attributen zurück, die durch das Objekt definiert sind

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

Aufrufparameter:

  • key: String, unbenutzt

Ergebnis zurückgeben:

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