オブジェクト組み込みオブジェクト

オブジェクトDgramSocket

dgram.Socketオブジェクトは、 dgram.Socketパケット機能EventEmitterカプセル化する機能EventEmitter

DgramSocketインスタンスは、 dgram.createSocket ()によって作成されます。 dgram.Socketインスタンスを作成dgram.Socketためにnewキーワードを使用する必要dgram.Socketません。

作成方法:

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

イベント

DgramSocketはEventEmitterを継承しEventEmitter 。オブジェクトの状態変更とデータ受信はすべてイベントの形式で実装されます。

イベントを閉じる

closeイベントは、 close()を使用してsocketを閉じた後にトリガーされsocket 。このイベントがトリガーされると、このsocket新しいmessageイベントはトリガーされません。

エラーイベント

エラーが発生すると、 errorイベントがトリガーされます。

リスニングイベント

socketがパケット情報のリッスンを開始すると、 listeningイベントがトリガーされます。このイベントは、UDPソケットが作成された直後にトリガーされます。

メッセージイベント

socketが新しいパケットを受信すると、 messageイベントがトリガーされます。 msgrinfoは、パラメーターとしてイベントハンドラーに渡されます。

  • msgBuffer 、メッセージ
  • rinfo :オブジェクト、リモートアドレス情報
    • address :文字列、送信者アドレス
    • family :文字列、アドレスタイプ(「IPv4」または「IPv6」)
    • port :番号、送信者ポート
    • size :数、メッセージサイズ

継承

静的プロパティ

defaultMaxListeners

整数、リスナーのデフォルトのグローバル最大数

1
static Integer DgramSocket.defaultMaxListeners;

メンバー機能

bind

この方法は行いますdgram.Socket 、指定のパケット情報監視portaddr 。バインディングが完了すると、 listeningイベントがトリガーされます。

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

呼び出しパラメーター:

  • port :整数、バインドポートを指定します。 port指定されていないか0の場合、オペレーティングシステムはランダムポートをバインドしようとします
  • addr :文字列、バインディングアドレスを指定します。アドレスが指定されていない場合、オペレーティングシステムはすべてのアドレスをリッスンしようとします。

このメソッドにより、 dgram.Socketは、 opts指定されたportaddressパケット情報を監視しopts 。バインディングが完了すると、 listeningイベントがトリガーされます。

1
DgramSocket.bind(Object opts) async;

呼び出しパラメーター:

  • opts :オブジェクト、バインディングパラメータを指定

send

ソケットでパケットを送信します

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

呼び出しパラメーター:

  • msgBuffer 、送信するデータを指定します
  • port :整数、送信先ポートを指定します
  • address :文字列、送信先アドレスを指定します

戻り結果:

  • Integer 、送信サイズを返します

ソケットでパケットを送信します

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

呼び出しパラメーター:

  • msgBuffer 、送信するデータを指定します
  • offset :整数、指定されたオフセットから送信を開始します
  • length :整数、指定された送信の長さ
  • port :整数、送信先ポートを指定します
  • address :文字列、送信先アドレスを指定します

戻り結果:

  • Integer 、送信サイズを返します

address

ソケットアドレス情報を含むオブジェクトを返します。 UDPソケットの場合、このオブジェクトにはアドレス、ファミリ、およびポートの属性が含まれます。

1
NObject DgramSocket.address();

戻り結果:

  • NObjectは、オブジェクトバインディングアドレスを返します

close

現在のソケットを閉じます

1
DgramSocket.close();

現在のソケットを閉じます

1
DgramSocket.close(Function callback);

呼び出しパラメーター:

  • callback :関数、閉じた後のコールバック関数。これは、 closeイベントにリスナーを追加するのと同じです。

getRecvBufferSize

バッファサイズを受け取るクエリソケット

1
Integer DgramSocket.getRecvBufferSize();

戻り結果:

  • Integer 、クエリ結果を返す

getSendBufferSize

クエリソケット送信バッファサイズ

1
Integer DgramSocket.getSendBufferSize();

戻り結果:

  • Integer 、クエリ結果を返す

setRecvBufferSize

ソケット受信バッファサイズを設定します

1
DgramSocket.setRecvBufferSize(Integer size);

呼び出しパラメーター:

  • size :整数、設定するサイズを指定します

setSendBufferSize

ソケット送信バッファサイズを設定します

1
DgramSocket.setSendBufferSize(Integer size);

呼び出しパラメーター:

  • size :整数、設定するサイズを指定します

setBroadcast

SO_BROADCASTソケットオプションを設定またはクリアする

1
DgramSocket.setBroadcast(Boolean flag);

呼び出しパラメーター:

  • flag :ブール値。trueに設定すると、UDPパケットがローカルインターフェイスのブロードキャストアドレスに送信されます。

ref

fibjsプロセスが終了しないようにし、オブジェクトのバインド中にfibjsプロセスが終了しないようにします

1
DgramSocket DgramSocket.ref();

戻り結果:

  • DgramSocket 、現在のオブジェクトを返します

unref

fibjsプロセスの終了を許可し、オブジェクトのバインド中にfibjsプロセスの終了を許可します

1
DgramSocket DgramSocket.unref();

戻り結果:

  • DgramSocket 、現在のオブジェクトを返します

on

イベントハンドラーをオブジェクトにバインドします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

イベントハンドラーをオブジェクトにバインドします

1
Object DgramSocket.on(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名になり、プロパティ値はイベント処理関数になります。

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

addListener

イベントハンドラーをオブジェクトにバインドします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

イベントハンドラーをオブジェクトにバインドします

1
Object DgramSocket.addListener(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名になり、プロパティ値はイベント処理関数になります。

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

prependListener

イベントハンドラーをオブジェクト開始にバインドします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

イベントハンドラーをオブジェクト開始にバインドします

1
Object DgramSocket.prependListener(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名になり、プロパティ値はイベント処理関数になります。

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

once

ワンタイムイベント処理関数をオブジェクトにバインドします。ワンタイム処理関数は1回だけトリガーされます

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

ワンタイムイベント処理関数をオブジェクトにバインドします。ワンタイム処理関数は1回だけトリガーされます

1
Object DgramSocket.once(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名になり、プロパティ値はイベント処理関数になります。

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

prependOnceListener

イベントハンドラーをオブジェクト開始にバインドします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

イベントハンドラーをオブジェクト開始にバインドします

1
Object DgramSocket.prependOnceListener(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名になり、プロパティ値はイベント処理関数になります。

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

off

指定した機能をオブジェクト処理キューからキャンセルします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object DgramSocket.off(String ev);

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

指定した機能をオブジェクト処理キューからキャンセルします

1
Object DgramSocket.off(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定し、オブジェクトのプロパティ名をイベント名として使用し、プロパティ値をイベント処理関数として使用します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

removeListener

指定した機能をオブジェクト処理キューからキャンセルします

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

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します
  • func :関数、イベント処理関数を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object DgramSocket.removeListener(String ev);

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

指定した機能をオブジェクト処理キューからキャンセルします

1
Object DgramSocket.removeListener(Object map);

呼び出しパラメーター:

  • map :オブジェクト、イベントマッピング関係を指定し、オブジェクトのプロパティ名をイベント名として使用し、プロパティ値をイベント処理関数として使用します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

removeAllListeners

オブジェクト処理キューからすべてのイベントのすべてのリスナーをキャンセルします。イベントが指定されている場合は、指定されたイベントのすべてのリスナーを削除します。

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

呼び出しパラメーター:

  • evs :配列、イベントの名前を指定します

戻り結果:

  • Object 、イベントオブジェクト自体を返し、呼び出しをチェーンするのは簡単

setMaxListeners

互換性のためだけの、リスナー数のデフォルト制限

1
DgramSocket.setMaxListeners(Integer n);

呼び出しパラメーター:

  • n :整数、イベントの数を指定します

getMaxListeners

互換性のためにのみ、リスナー数のデフォルト制限を取得します

1
Integer DgramSocket.getMaxListeners();

戻り結果:

  • Integer 、デフォルトの制限数を返します

listeners

クエリオブジェクトの指定されたイベントのリスナーの配列

1
Array DgramSocket.listeners(String ev);

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します

戻り結果:

  • Arrayは、指定されたイベントのリスナーの配列を返します

listenerCount

クエリオブジェクトの指定されたイベントのリスナーの数

1
Integer DgramSocket.listenerCount(String ev);

呼び出しパラメーター:

  • ev :文字列、イベントの名前を指定します

戻り結果:

  • Integer 、指定されたイベントのリスナーの数を返します

eventNames

リスナーイベント名のクエリ

1
Array DgramSocket.eventNames();

戻り結果:

  • Array 、イベント名の配列を返します

emit

イベントを積極的にトリガーする

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

呼び出しパラメーター:

  • ev :文字列、イベント名
  • args :...、イベントハンドラーに渡されるイベントパラメーター

戻り結果:

  • Boolean 、イベントトリガーステータスを返し、応答イベントがある場合はtrueを返し、それ以外の場合はfalseを返します

toString

オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。

1
String DgramSocket.toString();

戻り結果:

  • String 、オブジェクトの文字列表現を返します

toJSON

オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

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

呼び出しパラメーター:

  • key :文字列、未使用

戻り結果:

  • Value 、シリアル化可能なJSONを含む値を返します