Objekt eingebautes Objekt

Objekt DgramSocket

dgram.Socket Objekt ist eine Funktion , um eine Paketfunktionalität zur Einkapselung EventEmitter .

DgramSocket-Instanzen werden von dgram.createSocket () erstellt. dgram.Socket müssen das neue Schlüsselwort nicht verwenden, um eine dgram.Socket Instanz zu erstellen.

Erstellungsmethode:

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

Ereignis

DgramSocket erbt von EventEmitter , die EventEmitter des Objekts und die EventEmitter werden alle durch Ereignisse implementiert.

Ereignis schließen

close wird ausgelöst, nachdem ein socket mit close() . Sobald dieses Ereignis ausgelöst wird, wird an diesem socket kein neues message ausgelöst.

Fehlerereignis

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

Hörereignis

Wenn ein socket beginnt, auf Paketinformationen zu warten, wird das listening ausgelöst. Dieses Ereignis wird unmittelbar nach dem Erstellen des UDP-Sockets ausgelöst.

Nachrichtenereignis

Wenn ein neues Paket vom socket empfangen wird, wird das message ausgelöst. msg und rinfo werden als Parameter an die rinfo des Ereignisses übergeben.

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

Vererbung

Statische Eigenschaft

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

Mitgliedsfunktion

bind

Mit dieser Methode dgram.Socket auf dgram.Socket für den angegebenen port und die angegebene addr . Wenn die Bindung abgeschlossen ist, wird ein listening ausgelöst.

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

Parameter aufrufen:

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

Diese Methode lässt dgram.Socket auf dgram.Socket über den durch dgram.Socket angegebenen port und die address opts . Wenn die Bindung abgeschlossen ist, wird ein listening ausgelöst.

1
DgramSocket.bind(Object opts) async;

Parameter aufrufen:

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

Parameter aufrufen:

  • msg : Buffer , geben Sie die zu sendenden Daten an
  • port : Integer, geben Sie den zu sendenden Zielport an
  • address : Zeichenfolge, geben Sie die Zieladresse für das Senden an

Gibt das Ergebnis zurück:

  • Integer , Rücksendegröße zurückgeben

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;

Parameter aufrufen:

  • msg : Buffer , geben Sie die zu sendenden Daten an
  • offset : Ganzzahl, vom angegebenen Offset senden
  • length : Ganzzahl, senden Sie die angegebene Länge
  • port : Integer, geben Sie den zu sendenden Zielport an
  • address : Zeichenfolge, geben Sie die Zieladresse für das Senden an

Gibt das Ergebnis zurück:

  • Integer , Rücksendegröße zurückgeben

address

Gibt ein Objekt zurück, das Socket-Adressinformationen enthält. Bei UDP-Sockets enthält dieses Objekt die Attribute Adresse, Familie und Port.

1
NObject DgramSocket.address();

Gibt das Ergebnis zurück:

  • NObject , Objektbindungsadresse zurückgeben

close

Schließen Sie die aktuelle Steckdose

1
DgramSocket.close();

Schließen Sie die aktuelle Steckdose

1
DgramSocket.close(Function callback);

Parameter aufrufen:

  • callback : Funktion, Rückruffunktion nach Abschluss des Abschlusses, entspricht dem Hinzufügen eines Listeners für das close

getRecvBufferSize

Abfrage-Socket empfängt Puffergröße

1
Integer DgramSocket.getRecvBufferSize();

Gibt das Ergebnis zurück:

  • Integer , gibt das Abfrageergebnis zurück

getSendBufferSize

Abfrage-Socket-Sendepuffergröße

1
Integer DgramSocket.getSendBufferSize();

Gibt das Ergebnis zurück:

  • Integer , gibt das Abfrageergebnis zurück

setRecvBufferSize

Stellen Sie die Größe des Socket-Empfangspuffers ein

1
DgramSocket.setRecvBufferSize(Integer size);

Parameter aufrufen:

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

setSendBufferSize

Stellen Sie die Größe des Socket-Sendepuffers ein

1
DgramSocket.setSendBufferSize(Integer size);

Parameter aufrufen:

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

setBroadcast

Aktivieren oder deaktivieren Sie die Socket-Option SO_BROADCAST

1
DgramSocket.setBroadcast(Boolean flag);

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • DgramSocket gibt das aktuelle Objekt zurück

unref

Lassen Sie den Fibjs-Prozess beenden, und lassen Sie den Fibjs-Prozess während der Objektbindung beenden

1
DgramSocket DgramSocket.unref();

Gibt das Ergebnis zurück:

  • DgramSocket gibt das aktuelle Objekt zurück

on

Binden Sie einen Ereignishandler an ein Objekt

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an ein Objekt

1
Object DgramSocket.on(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

addListener

Binden Sie einen Ereignishandler an ein Objekt

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Binden Sie einen Ereignishandler an ein Objekt

1
Object DgramSocket.addListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

prependListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object DgramSocket.prependListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

once

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

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

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

1
Object DgramSocket.once(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

prependOnceListener

Binden Sie einen Ereignishandler an den Anfang des Objekts

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

Binden Sie einen Ereignishandler an den Anfang des Objekts

1
Object DgramSocket.prependOnceListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignishandler verwendet

Gibt das Ergebnis zurück:

  • Object , gibt die Anzahl der erfolgreichen Bindungen zurück oder 0, wenn die Funktion gebunden ist

off

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.off(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

1
Object DgramSocket.off(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

removeListener

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

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

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses
  • func : Funktion, Event-Handler-Funktion angeben

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Brechen Sie alle Funktionen in der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.removeListener(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

Nicht spezifizierte Funktion aus der Objektverarbeitungswarteschlange

1
Object DgramSocket.removeListener(Object map);

Parameter aufrufen:

  • map : Object, gibt die Ereigniszuordnungsbeziehung an, der Objekteigenschaftsname wird als Ereignisname verwendet und der Eigenschaftswert wird als Ereignisverarbeitungsfunktion verwendet

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

removeAllListeners

Brechen Sie alle Listener für alle Ereignisse aus der Objektverarbeitungswarteschlange ab. Wenn ein Ereignis angegeben ist, entfernen Sie alle Listener für das angegebene Ereignis.

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

Parameter aufrufen:

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

Gibt das Ergebnis zurück:

  • Object , gibt das Ereignisobjekt selbst zurück, was für verkettete Aufrufe praktisch ist

setMaxListeners

Standardmäßig Anzahl der Listener, nur aus Kompatibilitätsgründen

1
DgramSocket.setMaxListeners(Integer n);

Parameter aufrufen:

  • n : Ganzzahl, die Anzahl der angegebenen Ereignisse

getMaxListeners

Holen Sie sich die Standardbegrenzung für Listener, nur aus Kompatibilitätsgründen

1
Integer DgramSocket.getMaxListeners();

Gibt das Ergebnis zurück:

  • Integer , gibt die Standardgrenzwertnummer zurück

listeners

Das Listener-Array für das angegebene Ereignis des Abfrageobjekts

1
Array DgramSocket.listeners(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

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

listenerCount

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

1
Integer DgramSocket.listenerCount(String ev);

Parameter aufrufen:

  • ev : String, der Name des angegebenen Ereignisses

Gibt das Ergebnis zurück:

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

eventNames

Abfragen des Listener-Ereignisnamens

1
Array DgramSocket.eventNames();

Gibt das Ergebnis zurück:

  • Array , gibt ein Array von Ereignisnamen zurück

emit

Ereignis aktiv auslösen

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

Parameter aufrufen:

  • ev : String, Ereignisname
  • args : ..., Ereignisparameter werden an den Ereignishandler übergeben

Gibt das Ergebnis zurück:

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

toString

Gibt eine Zeichenfolgendarstellung des Objekts zurück, normalerweise "[Native Object]". Objekte können gemäß ihren eigenen Merkmalen neu implementiert werden

1
String DgramSocket.toString();

Gibt das Ergebnis zurück:

  • String , gibt eine String-Darstellung des Objekts zurück

toJSON

Gibt eine JSON-Darstellung des Objekts zurück, die normalerweise eine Sammlung lesbarer Eigenschaften zurückgibt, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Gibt das Ergebnis zurück:

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