Class CardanoWsServer

Hierarchy

WsProvider
- CardanoWsServer

Constructors

constructor

new CardanoWsServer(dependencies: WsServerDependencies, cfg: WsServerConfiguration): CardanoWsServer
Parameters
- dependencies: WsServerDependencies
- cfg: WsServerConfiguration
Returns CardanoWsServer
Overrides WsProvider.constructor
- Defined in packages/cardano-services/src/WsServer/server.ts:103

Properties

`Private` cardanoNode

cardanoNode: CardanoNode

`Private` closeNotify

closeNotify: (() => void) = noop

Type declaration

- (): void
- Returns void

`Private` closing

closing: boolean = false

`Private` db

db: Pool

health$

health$: Observable<WSHealthCheckResponse>

`Private` heartbeatInterval

heartbeatInterval: undefined | Timer

`Private` lastReceivedNotification

lastReceivedNotification: number = 0

`Private` lastSentNotification

lastSentNotification: number = 0

`Private` lastSlot

lastSlot: Slot = ...

`Private` logger

logger: Logger

`Private` networkInfo

networkInfo: NetworkInfoResponses

`Private` notifications

notifications: Map<number, NotificationBody> = ...

`Private` server

server: Server<typeof IncomingMessage, typeof ServerResponse>

`Private` stakeInterval

stakeInterval: undefined | Timer

`Private` syncing

syncing: boolean = true

`Private` wss

wss: WebSocketServer

Methods

close

close(callback?: (() => void)): void
Closes the server.
Parameters
- Optional callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:142

`Private` createHttpServer

createHttpServer(): Server<typeof IncomingMessage, typeof ServerResponse>
Creates a simple HTTP server which just handles the /health URL. Mainly used to listen the WS server.

Returns Server<typeof IncomingMessage, typeof ServerResponse>
- Defined in packages/cardano-services/src/WsServer/server.ts:167

`Private` createOnConnection

createOnConnection(): ((ws: WebSocket) => void)
Returns ((ws: WebSocket) => void)
- - (ws: WebSocket): void
  - Parameters
    - ws: WebSocket
    Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:410

`Private` createOnNotification

createOnNotification(): ((msg: Notification) => Promise<void>)
Returns ((msg: Notification) => Promise<void>)
- - (msg: Notification): Promise<void>
  - Parameters
    - msg: Notification
    Returns Promise<void>
- Defined in packages/cardano-services/src/WsServer/server.ts:187

`Protected` emitHealth

emitHealth(reason?: string | HealthCheckResponse, __namedParameters?: EmitHealthOptions): void
Parameters
- Optional reason: string | HealthCheckResponse
- Optional __namedParameters: EmitHealthOptions
Returns void
Inherited from WsProvider.emitHealth
- Defined in packages/cardano-services-client/dist/cjs/WebSocket.d.ts:55

healthCheck

healthCheck(): Promise<WSHealthCheckResponse>
Returns Promise<WSHealthCheckResponse>
Inherited from WsProvider.healthCheck
- Defined in packages/cardano-services-client/dist/cjs/WebSocket.d.ts:56

`Private` init

init(port: number, dbCacheTtl: number, heartbeatInterval: number, heartbeatTimeout: number): Promise<void>
Parameters
- port: number
- dbCacheTtl: number
- heartbeatInterval: number
- heartbeatTimeout: number
Returns Promise<void>
- Defined in packages/cardano-services/src/WsServer/server.ts:329

`Private` listenNotify

listenNotify(): void
Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:258

`Private` onEpochRollover

onEpochRollover(): Promise<void>
Returns Promise<void>
- Defined in packages/cardano-services/src/WsServer/server.ts:492

`Private` request

request(ws: WebSocket, request: WSMessage): Promise<void>
Parameters
- ws: WebSocket
- request: WSMessage
Returns Promise<void>
- Defined in packages/cardano-services/src/WsServer/server.ts:509

`Private` send

send(message: WSMessage, notificationEvent?: NotificationEvent): void
Parameters
- message: WSMessage
- Optional notificationEvent: NotificationEvent
Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:541

`Private` sendNotification

sendNotification(notification: NotificationBody): void
Parameters
- notification: NotificationBody
Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:558

`Private` sendString

sendString(message: string): void
Parameters
- message: string
Returns void
- Defined in packages/cardano-services/src/WsServer/server.ts:576

Generated using TypeDoc