Objekt eingebautes Objekt

Objekt DgramSocket

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

Die DgramSocket-Instanz wird von dgram.createSocket () erstellt. Das neue Schlüsselwort ist nicht erforderlich, um dgram.Socket Instanzen zu erstellen.

So erstellen Sie:

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

Ereignisse

DgramSocket erbt von EventEmitter , die EventEmitter des Objekts sowie der Datenempfang werden in Form von Ereignissen implementiert.

Ereignis schließen

close wird ausgelöst, nachdem close() Schließen eines socket . 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, Paketinformationen abzuhören, 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 Ereignisverarbeitungsfunktion ü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

Diese Methode dgram.Socket , dass dgram.Socket die dgram.Socket auf dem angegebenen port und der angegebenen 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, geben Sie den Bindungsport an. Wenn port nicht angegeben ist oder 0, 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 dgram.Socket , dass dgram.Socket die dgram.Socket auf dem von dgram.Socket angegebenen port und der angegebenen 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 gesendeten Daten an
  • port : Integer, geben Sie den zu sendenden Zielport an
  • address : Zeichenfolge, geben Sie die zu sendende Zieladresse an

Ergebnis zurückgeben:

  • 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 gesendeten Daten an
  • offset : Integer, beginnen Sie mit dem Senden ab dem angegebenen Offset
  • length : Ganzzahl, senden Sie die angegebene Länge
  • port : Integer, geben Sie den zu sendenden Zielport an
  • address : Zeichenfolge, geben Sie die zu sendende Zieladresse an

Ergebnis zurückgeben:

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

address

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

1
NObject DgramSocket.address();

Ergebnis zurückgeben:

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

Parameter aufrufen:

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

getRecvBufferSize

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

1
Integer DgramSocket.getRecvBufferSize();

Ergebnis zurückgeben:

  • Integer , Abfrageergebnis zurückgeben

getSendBufferSize

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

1
Integer DgramSocket.getSendBufferSize();

Ergebnis zurückgeben:

  • Integer , Abfrageergebnis zurückgeben

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

Ergebnis zurückgeben:

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

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

Binden Sie einen Ereignishandler an das Objekt

1
Object DgramSocket.on(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

addListener

Binden Sie einen Ereignishandler an das Objekt

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

Binden Sie einen Ereignishandler an das Objekt

1
Object DgramSocket.addListener(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

  • 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, geben Sie den Namen des Ereignisses an
  • func : Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Ergebnis zurückgeben:

  • 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 Objektattributname wird als Ereignisname verwendet und der Attributwert wird als Ereignishandler verwendet

Ergebnis zurückgeben:

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

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

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

1
Object DgramSocket.once(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

  • 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, geben Sie den Namen des Ereignisses an
  • func : Funktion, geben Sie die Ereignisverarbeitungsfunktion an

Ergebnis zurückgeben:

  • 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 Objektattributname wird als Ereignisname verwendet und der Attributwert wird als Ereignishandler verwendet

Ergebnis zurückgeben:

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

off

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

  • 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, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

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

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.off(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

removeListener

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

  • 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, geben Sie den Namen des Ereignisses an

Ergebnis zurückgeben:

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

Brechen Sie die angegebene Funktion aus der Objektverarbeitungswarteschlange ab

1
Object DgramSocket.removeListener(Object map);

Parameter aufrufen:

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

Ergebnis zurückgeben:

  • 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 angegeben, entfernen Sie alle Listener für die angegebenen Ereignisse.

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

Parameter aufrufen:

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

Ergebnis zurückgeben:

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

setMaxListeners

Die Standardbegrenzung für Listener, nur aus Kompatibilitätsgründen

1
DgramSocket.setMaxListeners(Integer n);

Parameter aufrufen:

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

getMaxListeners

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

1
Integer DgramSocket.getMaxListeners();

Ergebnis zurückgeben:

  • Integer , geben Sie die Standardgrenzwertnummer zurück

listeners

Array von Listenern für das angegebene Ereignis des Abfrageobjekts

1
Array DgramSocket.listeners(String ev);

Parameter aufrufen:

  • 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

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

1
Integer DgramSocket.listenerCount(String ev);

Parameter aufrufen:

  • 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

Abfragen des Listener-Ereignisnamens

1
Array DgramSocket.eventNames();

Ergebnis zurückgeben:

  • 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 die Ereignishandlerfunktion übergeben

Ergebnis zurückgeben:

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

toString

Gibt die Zeichenfolgendarstellung des Objekts zurück, gibt im Allgemeinen "[Native Object]" zurück. Das Objekt kann gemäß seinen eigenen Merkmalen neu implementiert werden

1
String DgramSocket.toString();

Ergebnis zurückgeben:

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

toJSON

Gibt die JSON-Darstellung des Objekts zurück und gibt im Allgemeinen eine Sammlung lesbarer Attribute zurück, die vom Objekt definiert wurden

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

Parameter aufrufen:

  • key : String, unbenutzt

Ergebnis zurückgeben:

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