ISummary Interface
A single summary which can be tracked as it goes through its life cycle. The life cycle is: Local to Broadcast to Acked/Nacked.
Signature
export interface ISummary
Properties
| Property | Type | Description |
|---|---|---|
| clientId | string | |
| clientSequenceNumber | number |
Methods
| Method | Return Type | Description |
|---|---|---|
| waitAckNack() | Promise<ISummaryAckMessage | ISummaryNackMessage> | |
| waitBroadcast() | Promise<ISummaryOpMessage> |
Property Details
clientId
Signature
readonly clientId: string;
Type: string
clientSequenceNumber
Signature
readonly clientSequenceNumber: number;
Type: number
Method Details
waitAckNack
Signature
waitAckNack(): Promise<ISummaryAckMessage | ISummaryNackMessage>;
Returns
Return type: Promise<ISummaryAckMessage | ISummaryNackMessage>
waitBroadcast
Signature
waitBroadcast(): Promise<ISummaryOpMessage>;
Returns
Return type: Promise<ISummaryOpMessage>