Class TestingConnectionWrapper<T>`Abstract`

Deprecated

Use TCWrapper instead.

Type Parameters

Hierarchy

WebsocketConnection
- TestingConnectionWrapper
  - UpdateTestingConnectionWrapper

Constructors

constructor

new TestingConnectionWrapper<T>(token, expectedMethod, callback): TestingConnectionWrapper<T>
Type Parameters
- T
Parameters
- token: string
- expectedMethod: string
- callback: ((v) => any)
  - - (v): any
    - Parameters
      
      v: T
      
      Returns any
Returns TestingConnectionWrapper<T>
Overrides WebsocketConnection.constructor
- Defined in src/integration-testing/connections/testing-connection.ts:12

Properties

_id

_id: number = ++WebsocketConnection.AUTO_INCREMENT

Unique client id per server instance. This incremental value is resetted once the process is restarted.

`Protected` callback

callback: ((v) => any)

Type declaration

- (v): any
- Parameters
  - v: T
  Returns any

`Readonly` clientInformation

clientInformation: {
    browser: string;
    ip: string;
    location: string;
}

Information about the client connected to the WebSocket.

Type declaration

browser: string
ip: string
location: string

`Protected` connection

connection: WebSocket

The WebSocket connection object representing the connection to the client.

description

description: string = "PUBLIC"

Describes the clients auth state

`Protected` expectedMethod

expectedMethod: string

`Private` expectedMethodCalled

expectedMethodCalled: boolean = false

onCloseCallback

onCloseCallback: Function = ...

token

token: string = null

Can be used to store session credentials.

`Static` router

router: WebsocketRouter = ...

Refers to a websocket router instance.

Accessors

id

get id(): number
Gets the ID of the WebSocket connection.

Returns number
Inherited from WebsocketConnection.id
- Defined in src/websocket/server/connection/connection.ts:39

isClosed

get isClosed(): boolean
True if the connection has been closed

Returns boolean
Inherited from WebsocketConnection.isClosed
- Defined in src/websocket/server/connection/connection.ts:152

supportsCaching

get supportsCaching(): boolean
True if outbound caching is supported by the client.

Returns boolean
Inherited from WebsocketConnection.supportsCaching
- Defined in src/websocket/server/connection/connection.ts:104

Methods

addOutboundData

addOutboundData(method, data): void
Sets the cached outbound data for the associated outbound method.
Parameters
- method: string
  
  The method of the associated Outbound.
- data: any[]
  
  The contents that should be cached for the method.
Returns void
Inherited from WebsocketConnection.addOutboundData
- Defined in src/websocket/server/connection/connection.ts:207

enableCache

enableCache(): void
States that the client supports caching of outbound data.

Returns void
Inherited from WebsocketConnection.enableCache
- Defined in src/websocket/server/connection/connection.ts:97

enableLogging

enableLogging(): void
Enables message logging for the WebSocket connection.

Returns void

Deprecated
Inherited from WebsocketConnection.enableLogging
- Defined in src/websocket/server/connection/connection.ts:91

getOutboundDiffAndUpdateCache

getOutboundDiffAndUpdateCache(method, data, isPartial?): {
    data: string | any[];
    deleted: any[];
    inserted: any[];
    updated: any[];
}
Calculates the modified rows of data, that have been changed since the last time data was cached.
Parameters
- method: string
  
  The method of the associated Outbound.
- data: {
  id: number;
  }[]
  
  The data returned from the outbound function.
- Optional isPartial: boolean
  
  True when a part of the data is only present
Returns {
    data: string | any[];
    deleted: any[];
    inserted: any[];
    updated: any[];
}
the data changes (inserted, updated, deleted)
- data: string | any[]
- deleted: any[]
- inserted: any[]
- updated: any[]
Inherited from WebsocketConnection.getOutboundDiffAndUpdateCache
- Defined in src/websocket/server/connection/connection.ts:254

getOutboundRequestConfig

getOutboundRequestConfig(method): {
    count: number;
    groupId: number;
    id: number;
}
Outbound request config is used to store the length of entries, that have been previously requested by this client for partially sent outbounds.
Parameters
- method: string
  
  The method of the outbound
Returns {
    count: number;
    groupId: number;
    id: number;
}
the outbound request config
- count: number
- groupId: number
- id: number
Inherited from WebsocketConnection.getOutboundRequestConfig
- Defined in src/websocket/server/connection/connection.ts:377

`Abstract` handleReceivedMessages

handleReceivedMessages(data): void
Parameters
- data: {
  method: string;
  value: any;
  }
  - method: string
  - value: any
Returns void
- Defined in src/integration-testing/connections/testing-connection.ts:22

`Protected` onClose

onClose(): void
Returns void
Inherited from WebsocketConnection.onClose
- Defined in src/websocket/server/connection/connection.ts:156

`Protected` onMessage

onMessage(message): void
Handles incoming WebSocket messages.
Parameters
- message: string
  
  The message received from the WebSocket connection.
Returns void
Inherited from WebsocketConnection.onMessage
- Defined in src/websocket/server/connection/connection.ts:124

resetOutboundCache

resetOutboundCache(method): void
Parameters
- method: string
Returns void
Inherited from WebsocketConnection.resetOutboundCache
- Defined in src/websocket/server/connection/connection.ts:242

send

send(method, value): void
Sends a message through the WebSocket connection.
Parameters
- method: string
  
  The method of the message.
- value: T
  
  The value of the message.
Returns void
Overrides WebsocketConnection.send
- Defined in src/integration-testing/connections/testing-connection.ts:24

setIp

setIp(ip): void
Sets the IP address of the client.
Parameters
- ip: string
  
  The IP address to set.
Returns void
Inherited from WebsocketConnection.setIp
- Defined in src/websocket/server/connection/connection.ts:341

setOutboundRequestConfig

setOutboundRequestConfig(method, count, groupId, id): void
Outbound request config is used to store the length of entries, that have been previously requested by this client for partially sent outbounds.
Parameters
- method: string
  
  The method of the outbound
- count: number
  
  The length of entries that have been requested.
- groupId: number
- id: number
Returns void
Inherited from WebsocketConnection.setOutboundRequestConfig
- Defined in src/websocket/server/connection/connection.ts:397

updateOutboundCache

updateOutboundCache(method, inserted, updated, deleted): void
Updates the cached outbound data for the associated outbound method.
Parameters
- method: string
  
  The method of the associated Outbound.
- inserted: any[]
  
  The contents that have been added since the last time.
- updated: any[]
  
  The contents that have been modified since the last time.
- deleted: any[]
  
  The contents that have been removed since the last time.
Returns void
Inherited from WebsocketConnection.updateOutboundCache
- Defined in src/websocket/server/connection/connection.ts:218

`Protected` withContext

withContext(func, path?, objectId?): Promise<any>
Parameters
- func: Function
- path: string = null
- objectId: number = null
Returns Promise<any>
Inherited from WebsocketConnection.withContext
- Defined in src/websocket/server/connection/connection.ts:423

`Static` addCloseHandler

addCloseHandler(callback): void
Adds a close handler to be called when the connection is closed.
Parameters
- callback: DecorableFunction
  
  The callback function to be called on connection close.
Returns void
Inherited from WebsocketConnection.addCloseHandler
- Defined in src/websocket/server/connection/connection.ts:25

`Static` `Protected` getLookup

getLookup(): any
Returns any
Inherited from WebsocketConnection.getLookup
- Defined in src/websocket/server/connection/connection.ts:354

`Static` waitToSucceed

waitToSucceed(done): void
Parameters
- done: (() => any)
  - - (): any
    - Returns any
Returns void
- Defined in src/integration-testing/connections/testing-connection.ts:36

Class TestingConnectionWrapper<T>Abstract

Deprecated

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

token: string

expectedMethod: string

callback: ((v) => any)

Parameters

v: T

Returns any

Returns TestingConnectionWrapper<T>

Properties

_id

Protected callback

Type declaration

Parameters

v: T

Returns any

Readonly clientInformation

Type declaration

browser: string

ip: string

location: string

Protected connection

description

Protected expectedMethod

Private expectedMethodCalled

onCloseCallback

token

Static router

Accessors

id

Returns number

isClosed

Returns boolean

supportsCaching

Returns boolean

Methods

addOutboundData

Parameters

method: string

data: any[]

Returns void

enableCache

Returns void

enableLogging

Returns void

Deprecated

getOutboundDiffAndUpdateCache

Parameters

method: string

data: { id: number; }[]

Optional isPartial: boolean

Returns { data: string | any[]; deleted: any[]; inserted: any[]; updated: any[]; }

data: string | any[]

deleted: any[]

inserted: any[]

updated: any[]

getOutboundRequestConfig

Parameters

method: string

Returns { count: number; groupId: number; id: number; }

count: number

groupId: number

id: number

Abstract handleReceivedMessages

Parameters

data: { method: string; value: any; }

method: string

Class TestingConnectionWrapper<T>`Abstract`

`Protected` callback

`Readonly` clientInformation

`Protected` connection

`Protected` expectedMethod

`Private` expectedMethodCalled

`Static` router

data: {
id: number;
}[]

`Optional` isPartial: boolean

Returns {
data: string | any[];
deleted: any[];
inserted: any[];
updated: any[];
}

Returns {
count: number;
groupId: number;
id: number;
}

`Abstract` handleReceivedMessages

data: {
method: string;
value: any;
}

`Protected` onClose

`Protected` onMessage

`Protected` withContext

`Static` addCloseHandler

`Static` `Protected` getLookup

`Static` waitToSucceed