@openiap/nodeapi / Exports / client

Class: client

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

• new client()

Properties

agent

• agent: clientAgent

Implementation of

iclient.agent

Defined in

src/client.ts:55

call

• call: any

Implementation of

iclient.call

Defined in

src/client.ts:75

connected

• connected: boolean = false

Implementation of

iclient.connected

Defined in

src/client.ts:66

connecting

• connecting: boolean = false

Implementation of

iclient.connecting

Defined in

src/client.ts:67

created

• created: Date

Implementation of

iclient.created

Defined in

src/client.ts:59

doping

• doping: boolean

Implementation of

iclient.doping

Defined in

src/client.ts:58

exchanges

• exchanges: any[] = []

Implementation of

iclient.exchanges

Defined in

src/client.ts:69

grpc

• grpc: FlowService

Implementation of

iclient.grpc

Defined in

src/client.ts:74

grpcStream

• grpcStream: any

Implementation of

iclient.grpcStream

Defined in

src/client.ts:76

id

• id: string = ""

Implementation of

iclient.id

Defined in

src/client.ts:52

jwt

• jwt: string

Implementation of

iclient.jwt

Defined in

src/client.ts:64

lastheartbeat

• lastheartbeat: Date

Implementation of

iclient.lastheartbeat

Defined in

src/client.ts:60

lastheartbeatsec

• lastheartbeatsec: string = "0"

Implementation of

iclient.lastheartbeatsec

Defined in

src/client.ts:62

lastheartbeatstr

• lastheartbeatstr: string

Implementation of

iclient.lastheartbeatstr

Defined in

src/client.ts:61

protocol

• protocol: clientType

Implementation of

iclient.protocol

Defined in

src/client.ts:56

queues

• queues: any[] = []

Implementation of

iclient.queues

Defined in

src/client.ts:68

remoteip

• remoteip: string = "unknown"

Implementation of

iclient.remoteip

Defined in

src/client.ts:54

replies

• replies: any

Implementation of

iclient.replies

Defined in

src/client.ts:77

seq

• seq: number = 0

Implementation of

iclient.seq

Defined in

src/client.ts:53

signedin

• signedin: boolean = false

Implementation of

iclient.signedin

Defined in

src/client.ts:65

stream

• stream: any

Implementation of

iclient.stream

Defined in

src/client.ts:73

streams

• streams: any

Implementation of

iclient.streams

Defined in

src/client.ts:78

url

• url: string

Implementation of

iclient.url

Defined in

src/client.ts:71

user

• user: any

Implementation of

iclient.user

Defined in

src/client.ts:63

version

• version: string

Implementation of

iclient.version

Defined in

src/client.ts:57

watches

• watches: changestream[] = []

Implementation of

iclient.watches

Defined in

src/client.ts:70

ws

• ws: any

Implementation of

iclient.ws

Defined in

src/client.ts:72

Methods

Close

▸ Close(): void

Returns

void

Implementation of

iclient.Close

Defined in

src/client.ts:145

Initialize

▸ Initialize(ws, stream, call, req): Promise<boolean>

Parameters

Name Type
ws any
stream any
call any
req any

Returns

Promise<boolean>

Implementation of

iclient.Initialize

Defined in

src/client.ts:80

SendWatch

▸ SendWatch(watch, next, span): void

Parameters

Name Type
watch any
next any
span any

Returns

void

Implementation of

iclient.SendWatch

Defined in

src/client.ts:132

UnWatch

▸ UnWatch(id, jwt): Promise<void>

Parameters

Name Type
id string
jwt string

Returns

Promise<void>

Implementation of

iclient.UnWatch

Defined in

src/client.ts:127

Watch

▸ Watch(aggregates, collectionname, jwt): Promise<string>

Parameters

Name Type
aggregates object[]
collectionname string
jwt string

Returns

Promise<string>

Implementation of

iclient.Watch

Defined in

src/client.ts:114

onConnected

▸ onConnected(client): void

Parameters

Name Type
client client

Returns

void

Implementation of

iclient.onConnected

Defined in

src/client.ts:94

onDisconnected

▸ onDisconnected(client, error): void

Parameters

Name Type
client client
error Error

Returns

void

Implementation of

iclient.onDisconnected

Defined in

src/client.ts:96

onMessage

▸ onMessage(client, message): Promise<Envelope>

Parameters

Name Type
client client
message any

Returns

Promise<Envelope>

Implementation of

iclient.onMessage

Defined in

src/client.ts:99

ping

▸ ping(span): void

Parameters

Name Type
span any

Returns

void

Implementation of

iclient.ping

Defined in

src/client.ts:102

queuecount

▸ queuecount(): number

Returns

number

Implementation of

iclient.queuecount

Defined in

src/client.ts:111