SocketServer.ts

SocketServer.ts overview

Service contract for servers that accept socket connections.

SocketServer exposes the bound server address and a long-running run loop that hands each accepted connection to a handler as a Socket.Socket. The module also defines TCP and Unix socket address models plus the server-level errors reported while opening or running a server. Platform layers provide concrete implementations of this service.

Since v4.0.0

---

Exports Grouped by Category

• errors
  • SocketServerError (class)
    • [ErrorTypeId] (property)
  • SocketServerErrorReason (type alias)
  • SocketServerOpenError (class)
  • SocketServerUnknownError (class)
• models
  • Address (type alias)
  • TcpAddress (interface)
  • UnixAddress (interface)
• services
  • SocketServer (class)
• type IDs
  • ErrorTypeId
  • ErrorTypeId (type alias)

---

errors

SocketServerError (class)

Tagged socket server error that wraps a server error reason and exposes its cause.

Signature

declare class SocketServerError {
  constructor(props: { readonly reason: SocketServerErrorReason })
}

Source

Since v4.0.0

[ErrorTypeId] (property)

Marks this value as a socket server error for runtime guards.

Signature

readonly [ErrorTypeId]: "@effect/platform/SocketServer/SocketServerError"

Source

Since v4.0.0

SocketServerErrorReason (type alias)

Union of socket server error reasons.

Signature

type SocketServerErrorReason = SocketServerOpenError | SocketServerUnknownError

Source

Since v4.0.0

SocketServerOpenError (class)

Error reason for failures that occur while opening a socket server.

Signature

declare class SocketServerOpenError

Source

Since v4.0.0

SocketServerUnknownError (class)

Error reason for uncategorized socket server failures.

Signature

declare class SocketServerUnknownError

Source

Since v4.0.0

models

Address (type alias)

Socket server address, either a TCP host and port or a Unix socket path.

Signature

type Address = UnixAddress | TcpAddress

Source

Since v4.0.0

TcpAddress (interface)

TCP socket server address with hostname and port.

Signature

export interface TcpAddress {
  readonly _tag: "TcpAddress"
  readonly hostname: string
  readonly port: number
}

Source

Since v4.0.0

UnixAddress (interface)

Unix socket server address identified by a filesystem path.

Signature

export interface UnixAddress {
  readonly _tag: "UnixAddress"
  readonly path: string
}

Source

Since v4.0.0

services

SocketServer (class)

Context service for a socket server, exposing its bound address and a run loop that handles each accepted Socket.

Signature

declare class SocketServer

Source

Since v4.0.0

type IDs

ErrorTypeId

Runtime type identifier attached to SocketServerError values.

Signature

declare const ErrorTypeId: "@effect/platform/SocketServer/SocketServerError"

Source

Since v4.0.0

ErrorTypeId (type alias)

Type-level identifier used to mark SocketServerError values.

Signature

type ErrorTypeId = "@effect/platform/SocketServer/SocketServerError"

Source

Since v4.0.0