ICacheDataAdapter<TQueueMessage,TCachedMessage> Interface

Definition

Namespace:

Orleans.Providers.Streams.Common

Assembly:

OrleansProviders.dll

Package:

Microsoft.Orleans.OrleansProviders v2.4.5

Pooled queue cache stores data in tightly packed structures that need to be transformed to various other formats quickly. Since the data formats may change by queue type and data format, this interface allows adapter developers to build custom data transforms appropriate for the various types of queue data.

public interface ICacheDataAdapter<in TQueueMessage,TCachedMessage> where TCachedMessage : struct

type ICacheDataAdapter<'QueueMessage, 'CachedMessage (requires 'CachedMessage : struct)> = interface

Public Interface ICacheDataAdapter(Of In TQueueMessage, TCachedMessage)

Type Parameters

TQueueMessage

This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.

TCachedMessage

Derived

Orleans.ServiceBus.Providers.EventHubDataAdapter

Properties

OnBlockAllocated

Should be set to OnBlockAllocated method of the cache's EvicationStrategy

Methods

GetBatchContainer(TCachedMessage)	Converts a cached message to a batch container for delivery
GetMessageDequeueTimeUtc(TCachedMessage)	Get cached message dequeue time
GetMessageEnqueueTimeUtc(TCachedMessage)	Get cached message enqueueTime
GetSequenceToken(TCachedMessage)	Gets the stream sequence token from a cached message.
GetStreamPosition(TQueueMessage)	Gets the stream position from a queue message
QueueMessageToCachedMessage(TCachedMessage, TQueueMessage, DateTime)	Converts a TQueueMessage message from the queue to a TCachedMessage cachable structures.