Class ClientFactory

Index

Constructors

Methods

addConnectionRestoredListener addNodeChangedListener close create createXmlHttpRequest forceReconnect getNetworkUsage getServerInfo getTask registerTask removeNodeChangedListener removeTask setFetchOptionsInterceptor setXmlHttpRequestInterceptor

Constructors

constructor

new ClientFactory(
address: string,
settings?: ClientFactorySettings,
): ClientFactory
Parameters
- address: string
- Optionalsettings: ClientFactorySettings
Returns ClientFactory
- Defined in jsclient.d.ts:68

Methods

addConnectionRestoredListener

addConnectionRestoredListener(listener: () => void): void
Parameters
- listener: () => void
Returns void
- Defined in jsclient.d.ts:82

addNodeChangedListener

addNodeChangedListener(
listener: (current: ServerInfo, previous: ServerInfo | null) => void,
): void
Parameters
- listener: (current: ServerInfo, previous: ServerInfo | null) => void
Returns void
- Defined in jsclient.d.ts:83

close

close(): void
Returns void
- Defined in jsclient.d.ts:74

create

create(settings?: ClientFactorySettings): Promise<Client>
Parameters
- Optionalsettings: ClientFactorySettings
Returns Promise<Client>
- Defined in jsclient.d.ts:72

createXmlHttpRequest

createXmlHttpRequest(): XMLHttpRequest
Returns XMLHttpRequest
- Defined in jsclient.d.ts:71

forceReconnect

forceReconnect(): void
Reconnect the socket now (a request answered NODE_GONE).

Returns void
- Defined in jsclient.d.ts:86

getNetworkUsage

getNetworkUsage(): NetworkUsageReporter
Returns NetworkUsageReporter
- Defined in jsclient.d.ts:75

getServerInfo

getServerInfo(): ServerInfo | null
The node the main socket is on; null before the first hello, or from a server without a fleet.

Returns ServerInfo | null
- Defined in jsclient.d.ts:81

getTask

getTask(client: Client, id: string, name: string, nodeId?: string): Task
Parameters
- client: Client
- id: string
- name: string
- OptionalnodeId: string
Returns Task
- Defined in jsclient.d.ts:78

registerTask

registerTask(task: Task): void
Parameters
- task: Task
Returns void
- Defined in jsclient.d.ts:77

removeNodeChangedListener

removeNodeChangedListener(
listener: (current: ServerInfo, previous: ServerInfo | null) => void,
): void
Parameters
- listener: (current: ServerInfo, previous: ServerInfo | null) => void
Returns void
- Defined in jsclient.d.ts:84

removeTask

removeTask(task: Pick<Task, "id">): void
Parameters
- task: Pick<Task, "id">
Returns void
- Defined in jsclient.d.ts:79

setFetchOptionsInterceptor

setFetchOptionsInterceptor(fetchOptionsInterceptor: unknown): void
Parameters
- fetchOptionsInterceptor: unknown
Returns void
- Defined in jsclient.d.ts:70

setXmlHttpRequestInterceptor

setXmlHttpRequestInterceptor(xmlHttpRequestCreationInterceptor: unknown): void
Parameters
- xmlHttpRequestCreationInterceptor: unknown
Returns void
- Defined in jsclient.d.ts:69