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

オブジェクト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、パラメーターとしてイベントハンドラーに渡されます。

  • msgBuffer、情報
  • 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指定しportaddrパケット情報リッスンします。バインディングが完全な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;

呼び出しパラメーター:

  • 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(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、指定されたイベントのリスナーの数を返します

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

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

呼び出しパラメーター:

  • o:値、クエリのオブジェクトを指定します
  • 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を含む値を返します