EventHubQueueCache Class

Reference

Definition

Namespace:: Orleans.ServiceBus.Providers

Assembly:: OrleansServiceBus.dll

Assembly:: Orleans.Streaming.EventHubs.dll

Package:: Microsoft.Orleans.OrleansServiceBus v1.5.10

Package:: Microsoft.Orleans.OrleansServiceBus v2.4.5

Package:: Microsoft.Orleans.OrleansServiceBus v3.6.5

Source:: EventHubQueueCache.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Message cache that stores EventData as a CachedEventHubMessage in a pooled message cache

public class EventHubQueueCache : Orleans.ServiceBus.Providers.EventHubQueueCache<Orleans.ServiceBus.Providers.CachedEventHubMessage>

public class EventHubQueueCache : IDisposable, Orleans.ServiceBus.Providers.IEventHubQueueCache, Orleans.Streams.IQueueFlowController

type EventHubQueueCache = class
    inherit EventHubQueueCache<CachedEventHubMessage>

type EventHubQueueCache = class
    interface IEventHubQueueCache
    interface IQueueFlowController
    interface IDisposable

Public Class EventHubQueueCache
Inherits EventHubQueueCache(Of CachedEventHubMessage)

Public Class EventHubQueueCache
Implements IDisposable, IEventHubQueueCache, IQueueFlowController

Inheritance: Object

EventHubQueueCache<CachedEventHubMessage>
EventHubQueueCache

Inheritance: Object
EventHubQueueCache

Implements: IEventHubQueueCache IQueueFlowController IDisposable

Constructors

EventHubQueueCache(Int32, IStreamQueueCheckpointer<String>, ICacheDataAdapter<EventData, CachedEventHubMessage>, ICacheDataComparer<CachedEventHubMessage>, ILogger, IEvictionStrategy<CachedEventHubMessage>, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a custom data adapter.
EventHubQueueCache(Int32, IStreamQueueCheckpointer<String>, ICacheDataAdapter<EventData, CachedEventHubMessage>, ICacheDataComparer<CachedEventHubMessage>, Logger, IEvictionStrategy<CachedEventHubMessage>, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a custom data adapter.
EventHubQueueCache(IStreamQueueCheckpointer<String>, ICacheDataAdapter<EventData, CachedEventHubMessage>, ICacheDataComparer<CachedEventHubMessage>, ILogger, IEvictionStrategy<CachedEventHubMessage>, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a custom data adapter.
EventHubQueueCache(IStreamQueueCheckpointer<String>, ICacheDataAdapter<EventData, CachedEventHubMessage>, ICacheDataComparer<CachedEventHubMessage>, Logger, IEvictionStrategy<CachedEventHubMessage>, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a custom data adapter.
EventHubQueueCache(IStreamQueueCheckpointer<String>, IObjectPool<FixedSizeBuffer>, TimePurgePredicate, ILogger, SerializationManager, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a buffer pool. Will use default data adapter
EventHubQueueCache(IStreamQueueCheckpointer<String>, IObjectPool<FixedSizeBuffer>, TimePurgePredicate, Logger, SerializationManager, ICacheMonitor, Nullable<TimeSpan>)	Construct cache given a buffer pool. Will use default data adapter
EventHubQueueCache(String, Int32, IObjectPool<FixedSizeBuffer>, IEventHubDataAdapter, IEvictionStrategy, IStreamQueueCheckpointer<String>, ILogger, ICacheMonitor, Nullable<TimeSpan>, Nullable<TimeSpan>)	EventHub queue cache.

Fields

cache	Underlying message cache implementation Protected for test purposes
cache	Underlying message cache implementation (Inherited from EventHubQueueCache<TCachedMessage>)
defaultMaxAddCount	Default max number of items that can be added to the cache between purge calls (Inherited from EventHubQueueCache<TCachedMessage>)

Properties

Checkpointer	Logic used to store queue position (Inherited from EventHubQueueCache<TCachedMessage>)
Partition

Methods

Add(List<EventData>, DateTime)	Add a list of EventHub EventData to the cache.
Add(List<EventData>, DateTime)	Add a list of EventHub EventData to the cache. (Inherited from EventHubQueueCache<TCachedMessage>)
Add(List<EventData>, DateTime)	Add a list of EventHub EventData to the cache. (Inherited from EventHubQueueCache<TCachedMessage>)
AddCachePressureMonitor(ICachePressureMonitor)	Add cache pressure monitor to the cache's back pressure algorithm
AddCachePressureMonitor(ICachePressureMonitor)	Add cache pressure monitor to the cache's back pressure algorithm (Inherited from EventHubQueueCache<TCachedMessage>)
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from EventHubQueueCache<TCachedMessage>)
GetCursor(IStreamIdentity, StreamSequenceToken)	Get a cursor into the cache to read events from a stream.
GetCursor(IStreamIdentity, StreamSequenceToken)	Get a cursor into the cache to read events from a stream. (Inherited from EventHubQueueCache<TCachedMessage>)
GetMaxAddCount()	The limit of the maximum number of items that can be added
GetMaxAddCount()	The limit of the maximum number of items that can be added (Inherited from EventHubQueueCache<TCachedMessage>)
GetOffset(CachedEventHubMessage)	Get offset from cached message. Left to derived class, as only it knows how to get this from the cached message.
GetOffset(TCachedMessage)	Get offset from cached message. Left to derived class, as only it knows how to get this from the cached message. (Inherited from EventHubQueueCache<TCachedMessage>)
OnPurge(Nullable<CachedEventHubMessage>, Nullable<CachedEventHubMessage>)	Handles cache purge signals
OnPurge(Nullable<TCachedMessage>, Nullable<TCachedMessage>)	Handles cache purge signals (Inherited from EventHubQueueCache<TCachedMessage>)
SignalPurge()	Send purge signal to the cache, the cache will perform a time based purge on its cached messages
SignalPurge()	Send purge signal to the cache, the cache will perform a time based purge on its cached messages (Inherited from EventHubQueueCache<TCachedMessage>)
TryCalculateCachePressureContribution(StreamSequenceToken, Double)	cachePressureContribution should be a double between 0-1, indicating how much danger the item is of being removed from the cache. 0 indicating no danger, 1 indicating removal is imminent.
TryGetNextMessage(Object, IBatchContainer)	Try to get the next message in the cache for the provided cursor.
TryGetNextMessage(Object, IBatchContainer)	Try to get the next message in the cache for the provided cursor. (Inherited from EventHubQueueCache<TCachedMessage>)

Applies to

Share via