Class TocketBase<T, S>

The base class that implements the core logic of Tocket. Since WebSockets are bidirectional most functionality is shared between clients and servers. This Class is not meant to be used directly, use any of the Client and Server classes that inherit from it.

Type Parameters

T extends "Client" | "Server"

Decides if this instance of the TocketBase Class belongs to a TocketClientBase or TocketServer instance.
S extends SocketDefinition

Definition object for the functionality of the Socket.

getCustomData

getCustomData<K>(key?): K extends Sk<S["data"] & {
        id: string;
    }>
    ? (S["data"] & {
        id: string;
    })[K]
    : S["data"]
Access the CustomData object of this Socket.
Type Parameters
- K extends string
Parameters
- Optional key: K
  
  The key of the CustomData property to fetch. If left out the entire CustomData Object is returned.
Returns K extends Sk<S["data"] & {
        id: string;
    }>
    ? (S["data"] & {
        id: string;
    })[K]
    : S["data"]
Either the content of the CustomData property or the CustomData Object
- Defined in base/TocketBase.ts:201

getPromiseId

getPromiseId(requestFilter): undefined | string
Parameters
- requestFilter: Partial<SocketRequest>
Returns undefined | string
- Defined in base/TocketBase.ts:60

Primary Controls

launch

launch: SocketMethods<S> = ...

getConnections

getConnections(arg?): ConnectionType<T, S>[]
Fetch all or a subset of current connections of the Socket, optionally narrowed by a filter.
Parameters
- Optional arg: ConnectionFilter<NonNullable<Connector<S>>>
  
  a Filter for the connections to be fetched. If left empty, all connections are returned.
Returns ConnectionType<T, S>[]
- Defined in base/TocketBase.ts:173

listPresets

listPresets(): string[]
List all registered communication presets

Returns string[]
Array of preset names
- Defined in base/TocketBase.ts:80

register

register<N>(name, handlerName?, defaultTarget?, timeout?): Communication<S["presets"][N], NonNullable<Connector<S>>>
Registers a communication preset.
Type Parameters
- N extends string
Parameters
- name: N
  
  identifier of this preset.
- Optional handlerName: string
  
  name of the handler function on the target Socket this should process the messages
- Optional defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>
  
  identifier of the Socket the communication should target. uses the 'main' socket by default
- timeout: number = ...
Returns Communication<S["presets"][N], NonNullable<Connector<S>>>
the generated Communication preset.
- Defined in base/TocketBase.ts:211

General Properties

clientID

clientID: undefined | string = undefined

Client id generated by the server, empty in the Base and Server versions of the class

`Protected` customData

customData: {
[K in string]: Serializable
} = ...

timeout

timeout: number = 1500

`Private` `Readonly` type

type: T

Type of the Socket, can either be "Server" or "Client"

Internal Methods

constructor

new TocketBase<T, S>(type, customData?, timeout?): TocketBase<T, S>
Constructor implementation
Type Parameters
- T extends "Client" | "Server"
- S extends SocketDefinition
Parameters
- type: T
  
  The Socket type.
- customData: {
  [K in string]: Serializable
  } = ...
  
  Object in which the socket can store its data.
- timeout: number = 1500
  
  Category
  General Properties
Returns TocketBase<T, S>
- Defined in base/TocketBase.ts:30

`Protected` _launch

_launch<N>(name, content?, targetFilter?): DefBack<S, N, "returns">
Launch a previously registered communication preset.
Type Parameters
- N extends string
Parameters
- name: N
  
  the name of the communication preset to start
- Optional content: DefBack<S, N, "content">
  
  the data used to initialize the connection.
- Optional targetFilter: ConnectionFilter<NonNullable<Connector<S>>>
  
  the identifier of the endpoint this should receive this message
Returns DefBack<S, N, "returns">
- Defined in base/TocketBase.ts:225

`Private` compileSocketRequest

compileSocketRequest(msg, command, oldID?): SocketRequest<any, S["presets"]>
Compiles a SocketRequest object from provided data.
Parameters
- msg: any
  
  the message body this should be transferred to the endpoint
- command: Sk<S["presets"]>
  
  the name of the endpoint's handler function this should process the message
- Optional oldID: string
  
  ID of the message this is being replied to.
Returns SocketRequest<any, S["presets"]>
SocketRequest Object
- Defined in base/TocketBase.ts:88

generateInterface

generateInterface<N>(presetName, handler, initialTarget, pID?): Handler<S["presets"][N], NonNullable<Connector<S>>>
Providing the communication method with smart and typed parameter functions.
Type Parameters
- N extends string
Parameters
- presetName: N
  
  Name of preset
- handler: Sk<S["presets"]>
  
  handler name
- initialTarget: ConnectionFilter<NonNullable<Connector<S>>>
  
  targetName
- Optional pID: string
  
  PID instance
Returns Handler<S["presets"][N], NonNullable<Connector<S>>>
The finished method handler
- Defined in base/TocketBase.ts:122

`Protected` makeUUID

makeUUID(): string
Dummy ID generator, since the actual ID generation depends on the final environment.

Returns string
empty string.
- Defined in base/TocketBase.ts:58

`Private` objectFilter

objectFilter(comparisonObject, targetObject): targetObject is Record<string, any>
Compares to objects based on their contents recursively.
Parameters
- comparisonObject: Record<string, any>
  
  A filter object
- targetObject: Record<string, any>
  
  The "real" object to test against
Returns targetObject is Record<string, any>
true if the targetObject contains identical properties to the filter object, otherwise false
- Defined in base/TocketBase.ts:106

setCustomData

setCustomData(property, value): void
Modifies custom data on a Socket or Client. All connected Sockets and Clients receive the change immediately.
Parameters
- property: Sk<S["data"]>
  
  name of the property to set
- value: Serializable
  
  new value of the property
Returns void
- Defined in base/TocketBase.ts:192

Internal Data

`Protected` connections

connections: Map<string, ConnectionType<T, S>> = ...

`Protected` presets

presets: {
[K in string]: Communication<S["presets"][K], NonNullable<Connector<S>>>
} = ...

Map holding all communication presets registered to the Socket

`Protected` promiseMap

promiseMap: Map<string, PromiseData> = ...

Class TocketBase<T, S>

Type Parameters

T extends "Client" | "Server"

S extends SocketDefinition

Hierarchy

Index

Primary Controls

General Properties

Internal Methods

Internal Data

getCustomData

Type Parameters

K extends string

Parameters

Optional key: K

Returns K extends Sk<S["data"] & { id: string; }> ? (S["data"] & { id: string; })[K] : S["data"]

getPromiseId

Parameters

requestFilter: Partial<SocketRequest>

Returns undefined | string

Primary Controls

launch

getConnections

Parameters

Optional arg: ConnectionFilter<NonNullable<Connector<S>>>

Returns ConnectionType<T, S>[]

listPresets

Returns string[]

register

Type Parameters

N extends string

Parameters

name: N

Optional handlerName: string

Optional defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>

timeout: number = ...

Returns Communication<S["presets"][N], NonNullable<Connector<S>>>

General Properties

clientID

Protected customData

timeout

Private Readonly type

Internal Methods

constructor

Type Parameters

T extends "Client" | "Server"

S extends SocketDefinition

Parameters

type: T

customData: { [K in string]: Serializable} = ...

timeout: number = 1500

Category

Returns TocketBase<T, S>

Protected _launch

Type Parameters

N extends string

Parameters

name: N

Optional content: DefBack<S, N, "content">

Optional targetFilter: ConnectionFilter<NonNullable<Connector<S>>>

Returns DefBack<S, N, "returns">

Private compileSocketRequest

Parameters

msg: any

command: Sk<S["presets"]>

Optional oldID: string

Returns SocketRequest<any, S["presets"]>

generateInterface

Type Parameters

N extends string

Parameters

presetName: N

handler: Sk<S["presets"]>

initialTarget: ConnectionFilter<NonNullable<Connector<S>>>

Optional pID: string

Returns Handler<S["presets"][N], NonNullable<Connector<S>>>

Protected makeUUID

Returns string

Private objectFilter

Parameters

`Optional` key: K

Returns K extends Sk<S["data"] & {
id: string;
}>
? (S["data"] & {
id: string;
})[K]
: S["data"]

`Optional` arg: ConnectionFilter<NonNullable<Connector<S>>>

`Optional` handlerName: string

`Optional` defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>

`Protected` customData

`Private` `Readonly` type

customData: {
[K in string]: Serializable
} = ...

`Protected` _launch

`Optional` content: DefBack<S, N, "content">

`Optional` targetFilter: ConnectionFilter<NonNullable<Connector<S>>>

`Private` compileSocketRequest

`Optional` oldID: string

`Optional` pID: string

`Protected` makeUUID

`Private` objectFilter

`Protected` connections

`Protected` presets

`Protected` promiseMap