Namespace Orleans.Runtime

Classes

ClientNotAvailableException

Indicates that a client is not longer reachable.

DeadlockException

Signifies that a silo has detected a deadlock / loop in a call graph.

GatewayTooBusyException

Signifies that a gateway silo is currently in overloaded / load shedding state and is unable to currently accept this message being sent.

GrainExtensionNotInstalledException

Signifies that an attempt was made to invoke a grain extension method on a grain where that extension was not installed.

GrainLifecycleStage

Stages of a grains lifecycle. TODO: Add more later, see ActivationInitializationStage Full grain lifecycle, including register, state setup, and stream cleanup should all eventually be triggered by the grain lifecycle.

GrainReference

This is the base class for all typed grain references.

GrainReferenceNotBoundException

Indicates that a GrainReference was not bound to the runtime before being used.

GuidId

Wrapper object around Guid. Can be used in places where Guid is optional and in those cases it can be set to null and will not use the storage of an empty Guid struct.

KeyedServiceCollectionExtensions

LimitExceededException

Signifies that a silo is in an overloaded state where some runtime limit setting is currently being exceeded, and so that silo is unable to currently accept this message being sent.

Logger

Interface of Orleans runtime for logging services.

LoggerExtensionMethods

LoggerExtensions

OrleansConfigurationException

Represents a configuration exception.

OrleansException

An exception class used by the Orleans runtime for reporting errors.

OrleansLifecycleCanceledException

Indicates a lifecycle was canceled, either by request or due to observer error.

OrleansMessageRejectionException

Indicates that an Orleans message was rejected.

PlacementStrategy

ReminderException

Exception related to Orleans Reminder functions or Reminder service.

RequestContext

This class holds information regarding the request currently being processed. It is explicitly intended to be available to application code.

SiloAddress

Data class encapsulating the details of silo addresses.

SiloUnavailableException

Signifies that an request was cancelled due to target silo unavailability.

Structs

TickStatus

The status of a tick when the tick is delivered to the registrar grain. In case of failures, it may happen that a tick is not delivered on time. The app can notice such missed missed ticks as follows. Upon receiving a tick, the app can calculate the theoretical number of ticks since start of the reminder as: curCount = (Now - FirstTickTime) / Period The app can keep track of it as 'count'. Upon receiving a tick, the number of missed ticks = curCount - count - 1 Thereafter, the app can set count = curCount

Interfaces

IAddressable

Marker interface for addressable endpoints, such as grains, observers, and other system-internal addressable endpoints

ICloseableLogConsumer

An interface used to consume log entries, when a Close function is also supported.

IFlushableLogConsumer

An interface used to consume log entries, when a Flush function is also supported.

IGrainExtension

Marker interface for grain extensions, used by internal runtime extension endpoints

IGrainLifecycle

IGrainReferenceRuntime

Runtime logic for GrainReferences to be usable. This service is not meant to be used directly by user code.

IGrainReminder

Handle for a persistent Reminder.

IGrainRuntime

The gateway of the Grain to the Orleans runtime. The Grain should only interact with the runtime through this interface.

IKeyedService<TKey, TService>

IKeyedServiceCollection<TKey, TService>

Collection of services that can be disambiguated by key

ILogConsumer

An interface used to consume log entries.

Enums

LoggerType

The ILogConsumer distinguishes between four categories of logs:

Value	Description
Runtime	Logs that are written by the Orleans run-time itself. This category should not be used by application code.
Grain	Logs that are written by application grains. This category should be used by code that runs as Orleans grains in a silo.
Application	Logs that are written by the client application. This category should be used by client-side application code.
Provider	Logs that are written by providers. This category should be used by provider code.

Severity

Severity levels for log messages.