SocketSelector

constructor

• new SocketSelector(source?: SocketSelector): SocketSelector

  Create an empty selector or copy registrations, callbacks, and the readiness snapshot.

  Parameters

  sourceOptional

  SocketSelector

  Returns

  SocketSelector

  Source & inheritance

Static ReadonlyReceive

Static ReadonlySend

add

• add(
      socket: Socket,
      readiness?: ReadinessType,
      callback?: ReadyCallback,
  ): boolean

  Register a live socket and readiness conditions; return false for duplicate or unopened sockets. Callbacks require explicit dispatch.

  Parameters

  socket

  Socket

  readiness

  ReadinessType = ReadinessType.Receive

  callbackOptional

  ReadyCallback

  Returns

  boolean

  Source & inheritance

assign

• assign(source: SocketSelector): this

  Copy another selector's registrations and snapshot, returning this. No wait may currently be pending.

  Parameters

  source

  SocketSelector

  Returns

  this

  Source & inheritance

clear

• clear(): void

  Clear registrations and readiness results, waking any pending wait.

  Returns

  void

  Source & inheritance

dispatchReadyCallbacks

• dispatchReadyCallbacks(): void

  Synchronously call registered callbacks for ready entries in the last wait.

  Returns

  void

  Source & inheritance

isReady

• isReady(socket: Socket, readiness?: ReadinessType): boolean

  Check whether the latest wait snapshot contains the given readiness.

  Parameters

  socket

  Socket

  readiness

  ReadinessType = ReadinessType.Receive

  Returns

  boolean

  Source & inheritance

remove

• remove(socket: Socket): boolean

  Remove a socket and its readiness results, returning whether it was registered; wake any pending wait.

  Parameters

  socket

  Socket

  Returns

  boolean

  Source & inheritance

wait

• wait(timeout?: ReadonlyValue): Promise<boolean>

  Wait asynchronously and refresh the readiness snapshot. Time.Zero disables the timeout; return whether any entry is ready. Concurrent wait calls are not allowed.

  Parameters

  timeout

  ReadonlyValue = Time.Zero

  Returns

  Promise<boolean>

  Source & inheritance