Class PRCClient

Parallel request controller client

Hierarchy

PRCClient

Index

Constructors

Properties

config connectionBalancer connections nextRequestId requestAckListeners requestCountListeners

Methods

addRequestCountListener clearRequestCountListener close connect endRequest getConnectionFromPool getNewRequestId getRequestCount receiveRequestAck receiveRequestCount startRequest

Constructors

constructor

new PRCClient(config: PRCClientConfig): PRCClient
Creates new PRCClient
Parameters
- config: PRCClientConfig
  
  Client configuration
Returns PRCClient
- Defined in client.ts:33

Properties

`Private` config

config: PRCClientConfig

`Private` connectionBalancer

connectionBalancer: number

`Private` connections

connections: PRCConnection[]

`Private` nextRequestId

nextRequestId: number

`Private` requestAckListeners

requestAckListeners: Map<number, PromiseListener<boolean>>

`Private` requestCountListeners

requestCountListeners: Map<string, PromiseListener<number>[]>

Methods

`Private` addRequestCountListener

addRequestCountListener(rType: string, listener: PromiseListener<number>): void
Adds request count listener
Parameters
- rType: string
  
  Request type
- listener: PromiseListener<number>
  
  Listener
Returns void
- Defined in client.ts:232

`Private` clearRequestCountListener

clearRequestCountListener(rType: string, listener: PromiseListener<number>): void
Removes request count listener
Parameters
- rType: string
  
  Request type
- listener: PromiseListener<number>
  
  Listener
Returns void
- Defined in client.ts:245

close

close(): void
Closes all the connections

Returns void
- Defined in client.ts:63

connect

connect(): void
Connects to the PRC server

Returns void
- Defined in client.ts:54

endRequest

endRequest(request: StartedRequest): void
Indicates the ending of a request
Parameters
- request: StartedRequest
  
  The started request object
Returns void
- Defined in client.ts:147

`Private` getConnectionFromPool

getConnectionFromPool(): PRCConnection
Gets a connection from the pool

Returns
A connection from the pool

Returns PRCConnection
- Defined in client.ts:73

`Private` getNewRequestId

getNewRequestId(): number
Gets a brand new ID for a request

Returns
The request ID

Returns number
- Defined in client.ts:89

getRequestCount

getRequestCount(requestType: string): Promise<number>
Counts the current number of parallel requests of a type

Returns
The current number of parallel requests for the type
Parameters
- requestType: string
  
  Arbitrary string to indicate the request type
Returns Promise<number>
- Defined in client.ts:166

receiveRequestAck

receiveRequestAck(id: number, limited: boolean): void
Receives a request ACK
Parameters
- id: number
  
  The request ID
- limited: boolean
  
  True if limited
Returns void
- Defined in client.ts:198

receiveRequestCount

receiveRequestCount(rType: string, count: number): void
Receives a request count
Parameters
- rType: string
  
  The request type
- count: number
  
  The request count
Returns void
- Defined in client.ts:213

startRequest

startRequest(requestType: string, limit: number): Promise<StartedRequest>
Indicates the start of a request

Returns
An object containing the information to end the request when necessary
Parameters
- requestType: string
  
  Arbitrary string to indicate the request type
- limit: number
  
  Máximum number of requests for the specified type allowed to be run in parallel
Returns Promise<StartedRequest>
- Defined in client.ts:103

Generated using TypeDoc