Skip to main content

SocketPubSubParameters

@webda/fs

Class: SocketPubSubParameters

Defined in: fs/src/socketpubsub.service.ts:11

Configuration for SocketPubSubService.

Extends​

  • ServiceParameters

Constructors​

Constructor​

new SocketPubSubParameters(): SocketPubSubParameters

Returns​

SocketPubSubParameters

Inherited from​

ServiceParameters.constructor

Properties​

path​

path: string

Defined in: fs/src/socketpubsub.service.ts:16

Filesystem path of the unix-domain socket. The first peer to bind this path becomes the broker; subsequent peers connect as clients.

reconnectDelay?​

optional reconnectDelay?: number

Defined in: fs/src/socketpubsub.service.ts:24

Reconnect delay in milliseconds when the broker disconnects. A small random jitter is added on top to avoid stampedes when several clients race to bind a new socket.

Default​

100

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: fs/src/socketpubsub.service.ts:31

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with