Teraslice Messaging: `Cluster Master Server Server`
cluster-master/server.Server
Hierarchy
-
↳
Server
Table of contents
Constructors
Properties
- _clients
- actionTimeout
- clientDisconnectTimeout
- closed
- httpServer
- isShuttingDown
- logger
- networkLatencyBuffer
- port
- server
- serverName
Accessors
- availableClientCount
- availableClients
- disconnectedClientCount
- disconnectedClients
- onlineClientCount
- onlineClients
- unavailableClientCount
- unavailableClients
Methods
- close
- emit
- ensureClient
- getClientMetadataFromSocket
- getClusterAnalytics
- getTimeout
- getTimeoutWithMax
- handleResponse
- handleSendResponse
- isClientConnected
- isClientReady
- listen
- onClientAvailable
- onClientDisconnect
- onClientError
- onClientOnline
- onClientReconnect
- onClientShutdown
- onClientUnavailable
- onExecutionFinished
- onceWithTimeout
- send
- sendExecutionAnalyticsRequest
- sendExecutionPause
- sendExecutionResume
- sendToAll
- shutdown
- start
- updateClientState
- waitForClientReady
Constructors
constructor
• new Server(opts
): Server
Parameters
Name | Type |
---|---|
opts | ServerOptions |
Returns
Overrides
Defined in
Properties
_clients
• Protected
_clients: ConnectedClients
Inherited from
Defined in
actionTimeout
• Protected
actionTimeout: number
Inherited from
Defined in
clientDisconnectTimeout
• Readonly
clientDisconnectTimeout: number
Inherited from
Server.clientDisconnectTimeout
Defined in
closed
• closed: boolean
= false
Inherited from
Defined in
httpServer
• Readonly
httpServer: Server
<typeof IncomingMessage
, typeof ServerResponse
>
Inherited from
Defined in
isShuttingDown
• isShuttingDown: boolean
Inherited from
Defined in
logger
• Protected
logger: Logger
Inherited from
Defined in
networkLatencyBuffer
• Protected
networkLatencyBuffer: number
Inherited from
Defined in
port
• Readonly
port: number
Inherited from
Defined in
server
• Readonly
server: Server
Inherited from
Defined in
serverName
• Readonly
serverName: string
Inherited from
Defined in
Accessors
availableClientCount
• get
availableClientCount(): number
Returns
number
Inherited from
core.Server.availableClientCount
Defined in
availableClients
• get
availableClients(): ConnectedClient
[]
Returns
Inherited from
core.Server.availableClients
Defined in
disconnectedClientCount
• get
disconnectedClientCount(): number
Returns
number
Inherited from
core.Server.disconnectedClientCount
Defined in
disconnectedClients
• get
disconnectedClients(): ConnectedClient
[]
Returns
Inherited from
core.Server.disconnectedClients
Defined in
onlineClientCount
• get
onlineClientCount(): number
Returns
number
Inherited from
core.Server.onlineClientCount
Defined in
onlineClients
• get
onlineClients(): ConnectedClient
[]
Returns
Inherited from
core.Server.onlineClients
Defined in
unavailableClientCount
• get
unavailableClientCount(): number
Returns
number
Inherited from
core.Server.unavailableClientCount
Defined in
unavailableClients
• get
unavailableClients(): ConnectedClient
[]
Returns
Inherited from
core.Server.unavailableClients
Defined in
Methods
close
▸ close(): void
Returns
void
Inherited from
Defined in
emit
▸ emit(eventName
, msg
): void
Parameters
Name | Type |
---|---|
eventName | string |
msg | EventMessage |
Returns
void
Inherited from
Defined in
ensureClient
▸ ensureClient(socket
): ConnectedClient
Parameters
Name | Type |
---|---|
socket | Socket |
Returns
Inherited from
Defined in
getClientMetadataFromSocket
▸ getClientMetadataFromSocket(socket
): ClientSocketMetadata
Parameters
Name | Type |
---|---|
socket | Socket |
Returns
Inherited from
Server.getClientMetadataFromSocket
Defined in
getClusterAnalytics
▸ getClusterAnalytics(): ClusterAnalytics
Returns
Defined in
getTimeout
▸ getTimeout(timeout?
): number
Parameters
Name | Type |
---|---|
timeout? | number |
Returns
number
Inherited from
Defined in
getTimeoutWithMax
▸ getTimeoutWithMax(maxTimeout
): number
Parameters
Name | Type |
---|---|
maxTimeout | number |
Returns
number
Inherited from
Defined in
handleResponse
▸ handleResponse(socket
, eventName
, fn
): void
Parameters
Name | Type |
---|---|
socket | SocketEmitter |
eventName | string |
fn | MessageHandler |
Returns
void
Inherited from
Defined in
handleSendResponse
▸ handleSendResponse(sent
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
sent | Message |
Returns
Promise
<null
| Message
>
Inherited from
Defined in
isClientConnected
▸ isClientConnected(clientId
): boolean
Parameters
Name | Type |
---|---|
clientId | string |
Returns
boolean
Inherited from
Defined in
isClientReady
▸ isClientReady(clientId
): boolean
Parameters
Name | Type |
---|---|
clientId | string |
Returns
boolean
Inherited from
Defined in
listen
▸ listen(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
onClientAvailable
▸ onClientAvailable(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientDisconnect
▸ onClientDisconnect(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientError
▸ onClientError(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientOnline
▸ onClientOnline(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientReconnect
▸ onClientReconnect(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientShutdown
▸ onClientShutdown(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onClientUnavailable
▸ onClientUnavailable(fn
): Server
Parameters
Name | Type |
---|---|
fn | (clientId : string ) => void |
Returns
Inherited from
Defined in
onExecutionFinished
▸ onExecutionFinished(fn
): void
Parameters
Name | Type |
---|---|
fn | (clientId : string , error? : ResponseError ) => void |
Returns
void
Defined in
onceWithTimeout
▸ onceWithTimeout(eventName
, timeout?
): Promise
<any
>
Parameters
Name | Type |
---|---|
eventName | string |
timeout? | number |
Returns
Promise
<any
>
Inherited from
Defined in
send
▸ send(clientId
, eventName
, payload?
, options?
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
clientId | string |
eventName | string |
payload | Payload |
options | SendOptions |
Returns
Promise
<null
| Message
>
Inherited from
Defined in
sendExecutionAnalyticsRequest
▸ sendExecutionAnalyticsRequest(exId
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
exId | string |
Returns
Promise
<null
| Message
>
Defined in
sendExecutionPause
▸ sendExecutionPause(exId
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
exId | string |
Returns
Promise
<null
| Message
>
Defined in
sendExecutionResume
▸ sendExecutionResume(exId
): Promise
<null
| Message
>
Parameters
Name | Type |
---|---|
exId | string |
Returns
Promise
<null
| Message
>
Defined in
sendToAll
▸ sendToAll(eventName
, payload?
, options?
): Promise
<(null
| Message
)[]>
Parameters
Name | Type |
---|---|
eventName | string |
payload? | Payload |
options | SendOptions |
Returns
Promise
<(null
| Message
)[]>
Inherited from
Defined in
shutdown
▸ shutdown(): Promise
<void
>
Returns
Promise
<void
>
Inherited from
Defined in
start
▸ start(): Promise
<void
>
Returns
Promise
<void
>
Defined in
updateClientState
▸ updateClientState(clientId
, state
): boolean
Parameters
Name | Type |
---|---|
clientId | string |
state | ClientState |
Returns
boolean
Inherited from
Defined in
waitForClientReady
▸ waitForClientReady(clientId
, timeout?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
clientId | string |
timeout? | number |
Returns
Promise
<boolean
>