Skip to main content Link Search Menu Expand Document (external link)

SocketServer overview

Added in v1.0.0


Table of contents


errors

SocketServerError (class)

Signature

export declare class SocketServerError

Added in v1.0.0

models

Address (type alias)

Signature

export type Address = UnixAddress | TcpAddress

Added in v1.0.0

SocketServer (interface)

Signature

export interface SocketServer {
  readonly [SocketServerTypeId]: SocketServerTypeId
  readonly address: Address
  readonly run: <R, E, _>(
    handler: (socket: Socket.Socket) => Effect.Effect<_, E, R>
  ) => Effect.Effect<never, SocketServerError, R>
}

Added in v1.0.0

TcpAddress (interface)

Signature

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

Added in v1.0.0

UnixAddress (interface)

Signature

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

Added in v1.0.0

tags

SocketServer

Signature

export declare const SocketServer: Context.Tag<SocketServer, SocketServer>

Added in v1.0.0

type ids

SocketServerTypeId

Signature

export declare const SocketServerTypeId: typeof SocketServerTypeId

Added in v1.0.0

SocketServerTypeId (type alias)

Signature

export type SocketServerTypeId = typeof SocketServerTypeId

Added in v1.0.0