Class DatatypeCacheEntry

Implementation of TopicCacheEntry for topics with a given datatype

Hierarchy

any
- DatatypeCacheEntry

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DatatypeCacheEntry(streams: StreamAdapter[], path: string, specification: TopicSpecification, datatype: DataType<any, any, any>): DatatypeCacheEntry

- Defined in internal/routing/topic-cache-datatype-entry.ts:33
Create a new DatatypeCacheEntry instance

Parameters
- streams: StreamAdapter[]
  
  the stream adapters
- path: string
  
  the topic path
- specification: TopicSpecification
  
  the topic specification
- datatype: DataType<any, any, any>
  
  the data type of the entry
Returns DatatypeCacheEntry

Properties

Private Optional buffer

buffer: Buffer

The CBOR data containing the cached value

Private datatype

datatype: DataType<any, any, any>

The data type of the entry

Private dontRetainValue

dontRetainValue: boolean

Private value

value: any

The current cached value

Methods

handleDelta

handleDelta(received: Buffer, registry: StreamRegistryImpl, errorHandler: function): void

- Defined in internal/routing/topic-cache-datatype-entry.ts:95
Handle a delta

Reads the delta of the entry's data type and caches it. The calls notifyValue

Parameters
- received: Buffer
  
  the content as a Buffer
- registry: StreamRegistryImpl
  
  the stream registry
- errorHandler: function
  - - (e: any): void
    - Parameters
      - e: any
      Returns void
Returns void

handleValue

handleValue(received: Buffer, registry: StreamRegistryImpl, errorHandler: function): void

- Defined in internal/routing/topic-cache-datatype-entry.ts:67
Handle a value

Reads a value of the entry's data type and caches it. The calls notifyValue

Parameters
- received: Buffer
  
  the content as a Buffer
- registry: StreamRegistryImpl
  
  the stream registry
- errorHandler: function
  
  an error handler that will be called if an error occurs
  - - (e: any): void
    - Parameters
      - e: any
      Returns void
Returns void

notifyValueToNewStream

notifyValueToNewStream(path: string, specification: TopicSpecification, stream: StreamAdapter): void

- Defined in internal/routing/topic-cache-datatype-entry.ts:123
Notify a new stream of the cached value

Parameters
- path: string
  
  the topic path
- specification: TopicSpecification
  
  the topic specification
- stream: StreamAdapter
  
  the stream to notify
Returns void