Class LoggedActionRenderer<T>

Decorates an IActionRenderer<T> so that all event messages are logged. In other words, this is an IActionRenderer<T> version of LoggedRenderer<T>.

Every single event message causes two log messages: one is logged before rendering, and other one is logged after rendering. If any exception is thrown it is also logged with the log level (regardless of Level configuration).

Inheritance
Object
LoggedRenderer<T>
LoggedActionRenderer<T>
Implements
Inherited Members
Namespace: Libplanet.Blockchain.Renderers
Assembly: Libplanet.dll
Syntax
public class LoggedActionRenderer<T> : LoggedRenderer<T>, IActionRenderer<T>, IRenderer<T> where T : IAction, new()
Type Parameters
Name Description
T

An IAction type. It should match to BlockChain<T>'s type parameter.
Examples
IActionRenderer<ExampleAction> actionRenderer = new SomeActionRenderer();
// Wraps the action renderer with LoggedActionRenderer:
actionRenderer = new LoggedActionRenderer<ExampleAction>(
    actionRenderer,
    Log.Logger,
    LogEventLevel.Information,
);

Constructors

| Improve this Doc View Source

LoggedActionRenderer(IActionRenderer<T>, ILogger, LogEventLevel)

Creates a new LoggedActionRenderer<T> instance which decorates the given action renderer.

Declaration
public LoggedActionRenderer(IActionRenderer<T> renderer, ILogger logger, LogEventLevel level = null)
Parameters
Type Name Description
IActionRenderer<T> renderer

The actual action renderer to forward all event messages to and actually render things.
ILogger logger

The logger to write log messages to. Note that all log messages this decorator writes become in the context of the renderer's type (with the context property SourceContext).
LogEventLevel level

The log event level. All log messages become this level.

Properties

| Improve this Doc View Source

ActionRenderer

The inner action renderer to forward all event messages to and actually render things.

Declaration
public IActionRenderer<T> ActionRenderer { get; }
Property Value
Type Description
IActionRenderer<T>

Methods

| Improve this Doc View Source

RenderAction(IAction, IActionContext, IAccountStateDelta)

Does things that should be done right after an action is executed and applied to the blockchain.

Declaration
public void RenderAction(IAction action, IActionContext context, IAccountStateDelta nextStates)
Parameters
Type Name Description
IAction action

An executed action.
IActionContext context

The equivalent context object to an object passed to the action's Execute(IActionContext) method. That means PreviousStates are the states right before this action executed. For the states after this action executed, use the nextStates argument instead.
IAccountStateDelta nextStates

The states right after this action executed, which means it is equivalent to the states action's Execute(IActionContext) method returned.
Remarks

It is guaranteed to be called only once for an action, and only after applied to the blockchain, unless an exception is thrown during executing the action (in that case RenderActionError(IAction, IActionContext, Exception) is called instead) or once the action has been unrendered.

Also note that this method is invoked after RenderBlock(Block<T>, Block<T>) method is called (where its second parameter newTip contains a transaction the action belongs to).

The reason why the parameter action takes IAction instead of T is because it can take block actions (BlockAction) besides transaction actions (Actions).

| Improve this Doc View Source

RenderActionError(IAction, IActionContext, Exception)

Does the similar things to RenderAction(IAction, IActionContext, IAccountStateDelta), except that this method is invoked when action has terminated with an exception.

Declaration
public void RenderActionError(IAction action, IActionContext context, Exception exception)
Parameters
Type Name Description
IAction action

An action which threw an exception during execution.
IActionContext context

The equivalent context object to an object passed to the action's Execute(IActionContext) method. That means PreviousStates are the states right before this action executed.
Exception exception

The exception thrown during executing the action.
Remarks

Also note that this method is invoked after RenderBlock(Block<T>, Block<T>) method is called (where its second parameter newTip contains a transaction the action belongs to).

The reason why the parameter action takes IAction instead of T is because it can take block actions (BlockAction) besides transaction actions (Actions).

| Improve this Doc View Source

RenderBlockEnd(Block<T>, Block<T>)

Does things that should be done right all actions in a new Block<T> are rendered.

Declaration
public void RenderBlockEnd(Block<T> oldTip, Block<T> newTip)
Parameters
Type Name Description
Block<T> oldTip

The previous Tip.
Block<T> newTip

The current Tip.
Remarks

It is guaranteed to be called only once for a block.

| Improve this Doc View Source

UnrenderAction(IAction, IActionContext, IAccountStateDelta)

Does things that should be undone right after the given action is invalidated (mostly due to reorg, i.e., a block which the action has belonged to becomes considered stale).

This method takes the equivalent arguments to RenderAction(IAction, IActionContext, IAccountStateDelta) method.

Declaration
public void UnrenderAction(IAction action, IActionContext context, IAccountStateDelta nextStates)
Parameters
Type Name Description
IAction action

A stale action.
IActionContext context

The equivalent context object to an object passed to the action's Execute(IActionContext) method. That means PreviousStates are the states right before this action executed. For the states after this action executed, use the nextStates argument instead.
IAccountStateDelta nextStates

The states right after this action executed, which means it is equivalent to the states action's Execute(IActionContext) method returned.
Remarks

As a rule of thumb, this should be the inverse of RenderAction(IAction, IActionContext, IAccountStateDelta) method with redrawing the graphics on the display at the finish.

| Improve this Doc View Source

UnrenderActionError(IAction, IActionContext, Exception)

Does the similar things to UnrenderAction(IAction, IActionContext, IAccountStateDelta), except that this method is invoked when action has terminated with an exception.

This method takes the equivalent arguments to RenderActionError(IAction, IActionContext, Exception) method.

Declaration
public void UnrenderActionError(IAction action, IActionContext context, Exception exception)
Parameters
Type Name Description
IAction action

An action which threw an exception during execution.
IActionContext context

The equivalent context object to an object passed to the action's Execute(IActionContext) method. That means PreviousStates are the states right before this action executed.
Exception exception

The exception thrown during executing the action.
Remarks

The reason why the parameter action takes IAction instead of T is because it can take block actions (BlockAction) besides transaction actions (Actions).

Implements