Class InMemoryBatch

An internal interface which defines a in memory batch

Implements

IInMemoryBatch

Index

Constructors

Methods

addEvent clear count createNew endpoint getItems split

Constructors

constructor

new InMemoryBatch(logger, endpoint, evts?, evtsLimitInMem?): InMemoryBatch
Parameters
- logger: IDiagnosticLogger
- endpoint: string
- Optionalevts: IPostTransmissionTelemetryItem[]
- OptionalevtsLimitInMem: number
Returns InMemoryBatch
- Defined in InMemoryBatch.ts:11

Methods

addEvent

addEvent(payload): any
Enqueue the payload
Parameters
- payload: IPostTransmissionTelemetryItem | ITelemetryItem
Returns any
Implementation of IInMemoryBatch.addEvent
- Defined in InMemoryBatch.ts:64

clear

clear(): void
Returns void
- Defined in InMemoryBatch.ts:78

count

count(): number
Returns the number of elements in the buffer

Returns number
Implementation of IInMemoryBatch.count
- Defined in InMemoryBatch.ts:73

createNew

createNew(endpoint, evts?, evtsLimitInMem?): any
create current buffer to a new endpoint
Parameters
- endpoint: string
  if not defined, current endpoint will be used
- Optionalevts: IPostTransmissionTelemetryItem[] | ITelemetryItem[]
  new events to be added
- OptionalevtsLimitInMem: number
Returns any
Implementation of IInMemoryBatch.createNew
- Defined in InMemoryBatch.ts:105

endpoint

endpoint(): any
Returns any
- Defined in InMemoryBatch.ts:68

getItems

getItems(): IPostTransmissionTelemetryItem[] | ITelemetryItem[]
Returns items stored in the buffer

Returns IPostTransmissionTelemetryItem[] | ITelemetryItem[]
Implementation of IInMemoryBatch.getItems
- Defined in InMemoryBatch.ts:82

split

split(fromEvt, numEvts?): any
Split this batch into 2 with any events > fromEvent returned in the new batch and all other events are kept in the current batch.
Parameters
- fromEvt: number
  The first event to remove from the current batch.
- OptionalnumEvts: number
  The number of events to be removed from the current batch and returned in the new one. Defaults to all trailing events
Returns any
Implementation of IInMemoryBatch.split
- Defined in InMemoryBatch.ts:94