ILogViewAdaptor<TLogView,TLogEntry> Interface

Reference

Definition

Namespace:: Orleans.LogConsistency

Assembly:: Orleans.dll

Assembly:: Orleans.Core.dll

Package:: Microsoft.Orleans.Core v1.5.10

Package:: Microsoft.Orleans.Core v2.4.5

Package:: Microsoft.Orleans.Core v3.6.5

Source:: ILogViewAdaptor.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.

A log view adaptor is the storage interface for ILogConsistentGrain, whose state is defined as a log view.

There is one adaptor per grain, which is installed by ILogConsistencyProvider when the grain is activated.

public interface ILogViewAdaptor<TLogView,TLogEntry> : Orleans.LogConsistency.ILogConsistencyDiagnostics, Orleans.LogConsistency.ILogViewRead<TLogView,TLogEntry>, Orleans.LogConsistency.ILogViewUpdate<TLogEntry> where TLogView : new()

type ILogViewAdaptor<'LogView, 'LogEntry (requires 'LogView : (new : unit -> 'LogView))> = interface
    interface ILogViewRead<'LogView, 'LogEntry (requires 'LogView : (new : unit -> 'LogView))>
    interface ILogViewUpdate<'LogEntry>
    interface ILogConsistencyDiagnostics

Public Interface ILogViewAdaptor(Of TLogView, TLogEntry)
Implements ILogConsistencyDiagnostics, ILogViewRead(Of TLogView, TLogEntry), ILogViewUpdate(Of TLogEntry)

Type Parameters

TLogView

Type for the log view

TLogEntry

Type for the log entry

Derived: Orleans.EventSourcing.Common.PrimaryBasedLogViewAdaptor<TLogView,TLogEntry,TSubmissionEntry>

Implements: ILogConsistencyDiagnostics ILogViewRead<TLogView,TLogEntry> ILogViewUpdate<TLogEntry>

Properties

ConfirmedVersion	The length of the confirmed prefix of the log (Inherited from ILogViewRead<TView,TLogEntry>)
ConfirmedView	Confirmed view of the log (reflecting only confirmed entries) (Inherited from ILogViewRead<TView,TLogEntry>)
TentativeView	Local, tentative view of the log (reflecting both confirmed and unconfirmed entries) (Inherited from ILogViewRead<TView,TLogEntry>)
UnconfirmedSuffix	A list of the submitted entries that do not yet appear in the confirmed prefix. (Inherited from ILogViewRead<TView,TLogEntry>)
UnresolvedConnectionIssues	Gets a list of all currently unresolved connection issues. (Inherited from ILogConsistencyDiagnostics)

Methods

ConfirmSubmittedEntries()	Confirm all submitted entries. Waits until all previously submitted entries appear in the confirmed prefix of the log. (Inherited from ILogViewUpdate<TLogEntry>)
DisableStatsCollection()	Turns off the statistics collection for this log-consistent grain. (Inherited from ILogConsistencyDiagnostics)
EnableStatsCollection()	Turns on the statistics collection for this log-consistent grain. (Inherited from ILogConsistencyDiagnostics)
GetStats()	Gets the collected statistics for this log-consistent grain. (Inherited from ILogConsistencyDiagnostics)
OnMultiClusterConfigurationChange(MultiClusterConfiguration)	Called after the silo receives a new multi-cluster configuration.
OnProtocolMessageReceived(ILogConsistencyProtocolMessage)	Called when a grain receives a message from a remote instance.
PostOnActivate()	Called during activation, right after the user-defined OnActivateAsync()..
PostOnDeactivate()	Called during deactivation, right after the user-defined OnDeactivateAsync().
PreOnActivate()	Called during activation, right before the user-defined OnActivateAsync().
RetrieveLogSegment(Int32, Int32)	Attempt to retrieve a segment of the log, possibly from storage. Throws NotSupportedException if the log cannot be read, which depends on the providers used and how they are configured. (Inherited from ILogViewRead<TView,TLogEntry>)
Submit(TLogEntry)	Submit a single log entry to be appended to the global log, either at the current or at any later position. (Inherited from ILogViewUpdate<TLogEntry>)
SubmitRange(IEnumerable<TLogEntry>)	Submit a range of log entries to be appended atomically to the global log, either at the current or at any later position. (Inherited from ILogViewUpdate<TLogEntry>)
Synchronize()	Get the latest log view and confirm all submitted entries. Waits until all previously submitted entries appear in the confirmed prefix of the log, and forces a refresh of the confirmed prefix. (Inherited from ILogViewUpdate<TLogEntry>)
TryAppend(TLogEntry)	Try to append a single log entry at the current position of the log. (Inherited from ILogViewUpdate<TLogEntry>)
TryAppendRange(IEnumerable<TLogEntry>)	Try to append a range of log entries atomically at the current position of the log. (Inherited from ILogViewUpdate<TLogEntry>)

Applies to

Share via