Namespaces
namespace	Cluster

namespace	Log

namespace	Monads

namespace	Ping

namespace	Service

namespace	TestKit

namespace	Tests

namespace	Utils

Classes
class	ActorSystemUtils
	Utilities to work with See also ActorSystem More...

class	BaseInstaller
	Base class to install KlusterKite plugin components More...

class	ConfigurationUtils
	Bundle of web related configuration utils More...

interface	IMessageRouter
	Base class to route messages. Used to give possibility to create routing mocks More...

class	Installer
	Installing components from current library More...

class	MessageRouter
	Base class to route messages. More...

class	NameSpaceActor
	Actor to provide namespace in actors tree. Usually used only once in library More...

class	ShardingProxyWrappperActor
	Wraps sharding proxy into well known path More...

class	ShardingWrappperActor
	Wraps sharding into well known path More...

Enumerations
enum	EnActorType { EnActorType.Simple, EnActorType.Singleton, EnActorType.SingletonProxy, EnActorType.Sharding, EnActorType.ShardingProxy }
	Types of actors to generate from See also NameSpaceActor More...

Functions
static void	RunPostStart (ContainerBuilder container, IComponentContext context)
	Runs all registered installers See also PostStart More...

static void	RunPreCheck (ContainerBuilder container, Config config)
	Runs all registered installers See also PreCheck More...

static void	RunComponentRegistration ([NotNull] ContainerBuilder builder, [NotNull] Config config)
	Performs the installation in the T:Castle.Windsor.IWindsorContainer. More...

static string	ReadTextResource (Assembly assembly, string resourceName)
	Reads texts resource More...

void	Install ([NotNull] ContainerBuilder container)
	Performs the installation in the T:Castle.Windsor.IWindsorContainer. More...

virtual void	PreCheck (Config config)
	Should check the config and environment for possible errors. If any found, shod throw the exception to prevent node from starting. More...

abstract Config	GetAkkaConfig ()
	Gets default akka configuration for current module More...

virtual IEnumerable< string >	GetRoles ()
	Gets list of roles, that would be assign to cluster node with this plugin installed. More...

virtual void	PostStart (IComponentContext context)
	This method will be run after service start. Methods are run in See also AkkaConfigLoadPriority order. More...

abstract void	RegisterComponents (ContainerBuilder container, Config config)
	Registering DI components More...

Enumeration Type Documentation

◆ EnActorType

enum KlusterKite.Core.EnActorType

strong

Types of actors to generate from

See also: NameSpaceActor

Enumerator
Simple	Just simple actor
Singleton	Cluster singleton actor
SingletonProxy	Cluster singleton proxy actor
Sharding	Cluster sharding manager
ShardingProxy	Cluster sharding proxy actor

Definition at line 15 of file EnActorType.cs.

Function Documentation

◆ GetAkkaConfig()

abstract Config KlusterKite.Core.GetAkkaConfig ( )

protectedpure virtual

Gets default akka configuration for current module

Returns: Akka configuration

◆ GetRoles()

virtual IEnumerable<string> KlusterKite.Core.GetRoles ( )

protectedvirtual

Gets list of roles, that would be assign to cluster node with this plugin installed.

Returns: The list of roles

Definition at line 266 of file BaseInstaller.cs.

◆ Install()

void KlusterKite.Core.Install ( [NotNull] ContainerBuilder container )

Performs the installation in the T:Castle.Windsor.IWindsorContainer.

Parameters

container The builder.

Definition at line 221 of file BaseInstaller.cs.

◆ PostStart()

virtual void KlusterKite.Core.PostStart ( IComponentContext context )

protectedvirtual

This method will be run after service start. Methods are run in

See also: AkkaConfigLoadPriority

order.

Parameters

context The context.

Definition at line 280 of file BaseInstaller.cs.

◆ PreCheck()

virtual void KlusterKite.Core.PreCheck ( Config config )

virtual

Should check the config and environment for possible errors. If any found, shod throw the exception to prevent node from starting.

Parameters

config Full akka config

Exceptions

Exception Thrown if there are error in configuration and/or environment

Definition at line 252 of file BaseInstaller.cs.

◆ ReadTextResource()

static string KlusterKite.Core.ReadTextResource	(	Assembly	assembly,
		string	resourceName
	)

static

Reads texts resource

Parameters

assembly	The resource containing assembly
resourceName	The resource name

Returns: The resource contents

Definition at line 201 of file BaseInstaller.cs.

◆ RegisterComponents()

abstract void KlusterKite.Core.RegisterComponents	(	ContainerBuilder	container,
		Config	config
	)

protectedpure virtual

Registering DI components

Parameters

container	The builder.
config	The config.

◆ RunComponentRegistration()

static void KlusterKite.Core.RunComponentRegistration	(	[NotNull] ContainerBuilder	builder,
		[NotNull] Config	config
	)

static

Performs the installation in the T:Castle.Windsor.IWindsorContainer.

Parameters

builder	The builder.
config	The config.

Definition at line 170 of file BaseInstaller.cs.

◆ RunPostStart()

static void KlusterKite.Core.RunPostStart	(	ContainerBuilder	container,
		IComponentContext	context
	)

static

Runs all registered installers

See also: PostStart

Parameters

container	The builder builder
context	The context.

Definition at line 126 of file BaseInstaller.cs.

◆ RunPreCheck()

static void KlusterKite.Core.RunPreCheck	(	ContainerBuilder	container,
		Config	config
	)

static

Runs all registered installers

See also: PreCheck

Parameters

container	The windsor builder.
config	Full akka config

Definition at line 147 of file BaseInstaller.cs.

Namespaces

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ EnActorType

Function Documentation

◆ GetAkkaConfig()

◆ GetRoles()

◆ Install()

◆ PostStart()

◆ PreCheck()

◆ ReadTextResource()

◆ RegisterComponents()

◆ RunComponentRegistration()

◆ RunPostStart()

◆ RunPreCheck()