API リファレンス
検索インデックスを準備中…

Socket

抽象

Node ネットワークトランスポートの共通基底クラス。 既定では非同期待機によるブロッキング動作を使います。

継承関係

階層 (theme_hierarchy_view_summary)

ソースと継承
メンバー一覧27

コンストラクター

プロパティ

メソッド

コンストラクター

プロパティ

blocking: boolean = true
ソースと継承
detach?: () => void

現在のトランスポートのイベントリスナーを削除します。

ソースと継承
epoch: number = 0
ソースと継承
failure?: Error
ソースと継承
transport?: SocketHandle

現在排他的に所有する Node トランスポート。 閉じるか再作成すると Node が解放します。

ソースと継承
AnyPort: 0

バインド時にシステムが利用可能なポートを自動割り当てします。

ソースと継承
Status: typeof SocketStatus = SocketStatus

ソケット操作状態の列挙型。

ソースと継承
Type: typeof SocketType = SocketType

ソケットトランスポートプロトコルの列挙型。

ソースと継承

メソッド

  • 引数

    check
    () => boolean
    generation
    number

    戻り値

    Promise<boolean>
    ソースと継承
  • 書き込みまたは世代のキャンセルを待ちます。閉じる際は下位層の 書き込みコールバックが発火するかどうかに依存しません。

    引数

    completion
    Promise<SocketStatus>
    generation
    number

    戻り値

    Promise<SocketStatus>
    ソースと継承
  • 現在のトランスポートを閉じ、旧世代の待機を起こします。 繰り返し呼び出しても安全で、ブロッキングフラグは変わりません。

    戻り値

    void
    ソースと継承
  • 指定ファミリーのトランスポートを割り当てます。 暗黙の接続やポートのバインドは行いません。

    引数

    addressTypeオプション

    戻り値

    void
    ソースと継承
  • Node トランスポートを引き継ぎ、古いものを閉じます。 生のファイル記述子は引き継ぎません。

    引数

    戻り値

    void
    ソースと継承
  • 最新の下位層のエラーを返し、記録がなければ undefined を返します。

    戻り値

    undefined | Error
    ソースと継承
  • サブクラスに下位の Node トランスポートへのアクセスを提供します。 未作成なら undefined です。

    戻り値

    undefined | SocketHandle
    ソースと継承
  • 既定では TCP の準備状態は読み取り可能バイトと書き込みバックプレッシャーに 従い、バインド済み UDP は送信可能です。サブクラスはこのフックと changed() で UDP データグラムと Server 接続キューを Selector に通知します。

    引数

    mask
    number

    戻り値

    number
    ソースと継承
  • 既定では Node トランスポートの生存状態を確認します。 サブクラスは内部 symbol をインポートせずに上書きできます。

    戻り値

    boolean
    ソースと継承
  • 非同期待機によるブロッキング動作を使うかどうかを返します。

    戻り値

    boolean
    ソースと継承
  • 閉じる際にサブクラスの状態を片付けます。 呼び出し時には古いトランスポートの関連付けは解除済みです。

    戻り値

    void
    ソースと継承
  • 既定の TCP/UDP/Server 状態リスナーを設定します。 サブクラスは独自の送受信キューを管理するために上書きできます。

    戻り値

    void
    ソースと継承
  • 読み書き可能になるまで非同期に待機するか設定します。 false なら現在のキュー状態に応じて NotReady または Partial を返します。

    引数

    blocking
    boolean

    戻り値

    void
    ソースと継承
  • 引き継ぐ前にトランスポートの型を検証し、古い接続を閉じた後で 型の誤りが判明することを防ぎます。

    引数

    戻り値

    void
    ソースと継承

シンボルメンバー

"[socketEvents]": EventEmitter<DefaultEventMap> = ...
ソースと継承
  • サブクラスで上書き可能な生存状態を Selector に公開します。

    戻り値

    boolean
    ソースと継承
  • サブクラスで上書き可能な準備条件を Selector に公開します。

    引数

    mask
    number

    戻り値

    number
    ソースと継承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0