オブジェクト組み込みオブジェクト
  1. 表紙
  2. 組み込みオブジェクト
  3. オブジェクトDgramソケット

オブジェクトDgramソケット

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: 数値、メッセージサイズ

相続関係

%0 object object toString() toJSON() EventEmitter EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object->EventEmitter DgramSocket DgramSocket bind() send() address() close() getRecvBufferSize() getSendBufferSize() addMembership() dropMembership() setMulticastTTL() setRecvBufferSize() setSendBufferSize() setBroadcast() ref() unref() EventEmitter->DgramSocket

静的プロパティ

defaultMaxListeners

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

1
static Integer DgramSocket.defaultMaxListeners;

メンバー関数

bind

この方法では、dgram.Socket指定されたportおよびaddrのパケット情報をリッスンします。バインディングが完了すると、イベントが発生しますlistening。

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

呼び出しパラメータ:

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

この方法では、dgram.Socket指定optsされた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、クエリ結果を返します

addMembership

IP_ADD_MEMBERSHIP ソケット オプションを使用して、指定された multicastAddress および multicastInterface でマルチキャスト グループに参加します。multicastInterface パラメーターが指定されていない場合、オペレーティング システムはインターフェイスを選択し、それにメンバーシップを追加します。使用可能な各インターフェイスにメンバーシップを追加するには、インターフェイスごとに 1 回ずつ、addMembership を複数回呼び出します。

1
2
DgramSocket.addMembership(String multicastAddress,
    String multicastInterface = "");

呼び出しパラメータ:

  • multicastAddress: 文字列。参加するマルチキャスト グループ アドレスを指定します。
  • multicastInterface: 文字列、参加するマルチキャスト グループ インターフェイスを指定します

dropMembership

IP_DROP_MEMBERSHIP ソケット オプションを使用して、multicastAddress のマルチキャスト グループを残します。ソケットが閉じられるかプロセスが終了すると、カーネルは自動的にこのメソッドを呼び出すため、ほとんどのアプリケーションではこのメソッドを呼び出す必要はありません。

1
2
DgramSocket.dropMembership(String multicastAddress,
    String multicastInterface = "");

呼び出しパラメータ:

  • multicastAddress: 文字列、削除するマルチキャスト グループ アドレスを指定します
  • multicastInterface: 文字列、削除するマルチキャスト グループ インターフェイスを指定します

setMulticastTTL

IP_MULTICAST_TTL ソケット オプションを設定する

1
DgramSocket.setMulticastTTL(Integer ttl);

呼び出しパラメータ:

  • ttl: 整数。設定する ttl を指定します。ttl パラメータは 0 ～ 255 の範囲で指定できます。ほとんどのシステムのデフォルト値は 1 です。

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

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

1
String DgramSocket.toString();

返される結果:

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

toJSON

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

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

呼び出しパラメータ:

  • key: 文字列、使用されません

返される結果:

  • Value、シリアル化可能な JSON を含む値を返します
© Copyright 2012-2024 fibjs.org |サポートしてください