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

オブジェクト DgramSocket

dgram.Socket オブジェクトは、関数をカプセル化するパッケージです。 EventEmitter.

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

作成方法:

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

イベント

から継承された DgramSocket EventEmitter, オブジェクトの状態変化とデータの受け入れは、すべてイベントの形で実現されます。

イベントを閉じる

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

エラーイベント

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

リスニングイベント

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

メッセージイベント

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

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

継承

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

静的プロパティ

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

メンバー関数

bind

この方法は dgram.Socketパケット情報を指定portしてaddrリッスンします。バインディングが完了listeningイベントをトリガーするとき

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

呼び出しパラメータ:

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

この方法は dgram.Socketopts指定portし、addressパケット情報に聞きます。バインディングが完了listeningイベントをトリガーするとき

1
DgramSocket.bind(Object opts) async;

呼び出しパラメータ:

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

send

ソケットでパケットを送信する

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

呼び出しパラメータ:

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

結果を返す:

  • Integer、返送サイズ

ソケットでパケットを送信する

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

呼び出しパラメータ:

  • msg: Buffer、送信するデータを指定
  • 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 回限りの処理関数は 1 回だけトリガーされます。

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

呼び出しパラメータ:

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

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

1 回限りのイベント処理関数をオブジェクトにバインドします。1 回限りの処理関数は 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(String ev);

呼び出しパラメータ:

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

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

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

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

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

1
String DgramSocket.toString();

結果を返す:

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

toJSON

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

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

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します