catapult::plugins Namespace Reference

Classes
class	CacheHandlers
	Utility class for registering cache-dependent handlers. More...
struct	MosaicRentalFeeConfiguration
	Mosaic rental fee configuration. More...
struct	NamespaceRentalFeeConfiguration
	Namespace rental fee configuration. More...
class	plugin_load_error
	Exception class that is thrown when an error is encountered while loading a plugin. More...
class	PluginManager
	A manager for registering plugins. More...
class	PluginModule
	A plugin module. More...
struct	StorageConfiguration
	Additional storage configuration. More...

Typedefs
using	PluginModules = std::vector< PluginModule >
	Container of plugin modules. More...

Functions
void	RegisterCoreSystem (PluginManager &manager)
void	RegisterMemoryHashCacheSystem (PluginManager &manager)
	Registers the in-memory hash cache with manager. More...
void	RegisterSignatureSystem (PluginManager &manager)
	Registers the signature verification system with manager. More...
void	RegisterAccountLinkSubsystem (PluginManager &manager)
	Registers account link support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateAccountLinkTransactionPlugin ()
	Creates an account link transaction plugin. More...
void	RegisterAggregateSubsystem (PluginManager &manager)
	Registers aggregate support with manager. More...
std::unique_ptr< TransactionPlugin >	CreateAggregateTransactionPlugin (const model::TransactionRegistry &transactionRegistry, model::EntityType transactionType)
	Creates an aggregate transaction plugin around transactionRegistry for transactions with type transactionType. More...
std::unique_ptr< TransactionPlugin >	CreateAggregateTransactionPlugin (const TransactionRegistry &transactionRegistry, const utils::TimeSpan &maxTransactionLifetime, EntityType transactionType)
void	RegisterHashLockSubsystem (PluginManager &manager)
	Registers hash lock support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateHashLockTransactionPlugin ()
	Creates a hash lock transaction plugin. More...
void	RegisterSecretLockSubsystem (PluginManager &manager)
	Registers secret lock support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateSecretLockTransactionPlugin ()
	Creates a secret lock transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateSecretProofTransactionPlugin ()
	Creates a secret proof transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateMosaicDefinitionTransactionPlugin (const MosaicRentalFeeConfiguration &config)
	Creates a mosaic definition transaction plugin given the rental fee configuration (config). More...
void	RegisterMosaicSubsystem (PluginManager &manager)
	Registers mosaic support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateMosaicSupplyChangeTransactionPlugin ()
	Creates a mosaic supply change transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateModifyMultisigAccountTransactionPlugin ()
	Creates a modify multisig account transaction plugin. More...
void	RegisterMultisigSubsystem (PluginManager &manager)
	Registers multisig support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateAddressAliasTransactionPlugin ()
	Creates an address alias transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateMosaicAliasTransactionPlugin ()
	Creates a mosaic alias transaction plugin. More...
void	RegisterNamespaceSubsystem (PluginManager &manager)
	Registers namespace support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateRegisterNamespaceTransactionPlugin (const NamespaceRentalFeeConfiguration &config)
	Creates a register namespace transaction plugin given the rental fee configuration (config). More...
void	RegisterAccountRestrictionSubsystem (PluginManager &manager)
	Registers account restriction support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateAccountAddressRestrictionTransactionPlugin ()
	Creates an account address restriction transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateAccountMosaicRestrictionTransactionPlugin ()
	Creates an account mosaic restriction transaction plugin. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateAccountOperationRestrictionTransactionPlugin ()
	Creates an account operation restriction transaction plugin. More...
void	RegisterTransferSubsystem (PluginManager &manager)
	Registers transfer support with manager. More...
PLUGIN_API std::unique_ptr< model::TransactionPlugin >	CreateTransferTransactionPlugin ()
	Creates a transfer transaction plugin. More...
void	LoadPluginByName (PluginManager &manager, PluginModules &modules, const std::string &directory, const std::string &name)
	Loads a plugin named name with manager from directory into modules. More...

Typedef Documentation

PluginModules

using catapult::plugins::PluginModules = typedef std::vector<PluginModule>

Container of plugin modules.

Function Documentation

CreateAccountAddressRestrictionTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateAccountAddressRestrictionTransactionPlugin

(

)

Creates an account address restriction transaction plugin.

Here is the caller graph for this function:

CreateAccountLinkTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateAccountLinkTransactionPlugin

(

)

Creates an account link transaction plugin.

Here is the caller graph for this function:

CreateAccountMosaicRestrictionTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateAccountMosaicRestrictionTransactionPlugin

(

)

Creates an account mosaic restriction transaction plugin.

Here is the caller graph for this function:

CreateAccountOperationRestrictionTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateAccountOperationRestrictionTransactionPlugin

(

)

Creates an account operation restriction transaction plugin.

Here is the caller graph for this function:

CreateAddressAliasTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateAddressAliasTransactionPlugin

(

)

Creates an address alias transaction plugin.

CreateAggregateTransactionPlugin() [1/2]

PLUGIN_API std::unique_ptr< model::TransactionPlugin > catapult::plugins::CreateAggregateTransactionPlugin	(	const TransactionRegistry &	transactionRegistry,
		EntityType	transactionType
	)

Creates an aggregate transaction plugin around transactionRegistry for transactions with type transactionType.

Here is the call graph for this function:

Here is the caller graph for this function:

CreateAggregateTransactionPlugin() [2/2]

PLUGIN_API std::unique_ptr< model::TransactionPlugin > catapult::plugins::CreateAggregateTransactionPlugin	(	const model::TransactionRegistry &	transactionRegistry,
		const utils::TimeSpan &	maxTransactionLifetime,
		model::EntityType	transactionType
	)

Creates an aggregate transaction plugin around transactionRegistry for transactions with type transactionType and specified max transaction lifetime (maxTransactionLifetime).

Here is the caller graph for this function:

CreateHashLockTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateHashLockTransactionPlugin

(

)

Creates a hash lock transaction plugin.

Here is the caller graph for this function:

CreateModifyMultisigAccountTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateModifyMultisigAccountTransactionPlugin

(

)

Creates a modify multisig account transaction plugin.

Here is the caller graph for this function:

CreateMosaicAliasTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateMosaicAliasTransactionPlugin

(

)

Creates a mosaic alias transaction plugin.

Here is the caller graph for this function:

CreateMosaicDefinitionTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateMosaicDefinitionTransactionPlugin

(

const MosaicRentalFeeConfiguration &

config

)

Creates a mosaic definition transaction plugin given the rental fee configuration (config).

Here is the caller graph for this function:

CreateMosaicSupplyChangeTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateMosaicSupplyChangeTransactionPlugin

(

)

Creates a mosaic supply change transaction plugin.

Here is the caller graph for this function:

CreateRegisterNamespaceTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateRegisterNamespaceTransactionPlugin

(

const NamespaceRentalFeeConfiguration &

config

)

Creates a register namespace transaction plugin given the rental fee configuration (config).

Here is the caller graph for this function:

CreateSecretLockTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateSecretLockTransactionPlugin

(

)

Creates a secret lock transaction plugin.

Here is the caller graph for this function:

CreateSecretProofTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateSecretProofTransactionPlugin

(

)

Creates a secret proof transaction plugin.

Here is the caller graph for this function:

CreateTransferTransactionPlugin()

PLUGIN_API std::unique_ptr<model::TransactionPlugin> catapult::plugins::CreateTransferTransactionPlugin

(

)

Creates a transfer transaction plugin.

Here is the caller graph for this function:

LoadPluginByName()

void catapult::plugins::LoadPluginByName	(	PluginManager &	manager,
		PluginModules &	modules,
		const std::string &	directory,
		const std::string &	name
	)

Loads a plugin named name with manager from directory into modules.

Here is the call graph for this function:

RegisterAccountLinkSubsystem()

PLUGIN_API void catapult::plugins::RegisterAccountLinkSubsystem

(

PluginManager &

manager

)

Registers account link support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterAccountRestrictionSubsystem()

PLUGIN_API void catapult::plugins::RegisterAccountRestrictionSubsystem

(

PluginManager &

manager

)

Registers account restriction support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterAggregateSubsystem()

PLUGIN_API void catapult::plugins::RegisterAggregateSubsystem

(

PluginManager &

manager

)

Registers aggregate support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterCoreSystem()

void catapult::plugins::RegisterCoreSystem

(

PluginManager &

manager

)

Registers the core system with manager.

Note

This plugin is required for basic system operation.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterHashLockSubsystem()

PLUGIN_API void catapult::plugins::RegisterHashLockSubsystem

(

PluginManager &

manager

)

Registers hash lock support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterMemoryHashCacheSystem()

PLUGIN_API void catapult::plugins::RegisterMemoryHashCacheSystem

(

PluginManager &

manager

)

Registers the in-memory hash cache with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterMosaicSubsystem()

PLUGIN_API void catapult::plugins::RegisterMosaicSubsystem

(

PluginManager &

manager

)

Registers mosaic support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterMultisigSubsystem()

PLUGIN_API void catapult::plugins::RegisterMultisigSubsystem

(

PluginManager &

manager

)

Registers multisig support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterNamespaceSubsystem()

PLUGIN_API void catapult::plugins::RegisterNamespaceSubsystem

(

PluginManager &

manager

)

Registers namespace support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterSecretLockSubsystem()

PLUGIN_API void catapult::plugins::RegisterSecretLockSubsystem

(

PluginManager &

manager

)

Registers secret lock support with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterSignatureSystem()

PLUGIN_API void catapult::plugins::RegisterSignatureSystem

(

PluginManager &

manager

)

Registers the signature verification system with manager.

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterTransferSubsystem()

PLUGIN_API void catapult::plugins::RegisterTransferSubsystem

(

PluginManager &

manager

)

Registers transfer support with manager.

Here is the call graph for this function:

Here is the caller graph for this function: