pip_services4_components library

Classes

Cleaner

Helper class that cleans stored object state.

Closer

Helper class that closes previously opened components.

CompositeFactory

Aggregates multiple factories into a single factory component. When a new component is requested, it iterates through factories to locate the one able to create the requested component.

ConfigParams

Contains a key-value map with configuration parameters. All values stored as strings and can be serialized as JSON or string forms. When retrieved the values can be automatically converted on read using GetAsXXX methods. The keys are case-sensitive, so it is recommended to use consistent C-style as: 'my_param'

Context

Basic implementation of an execution context.

ContextInfo

Context information component that provides detail information about execution context: container or/and process.

ContextResolver

Context resolver that processes context and extracts values from there. See IContext

DefaultInfoFactory

Creates information components by their descriptors.

DependencyResolver

Helper class for resolving component dependencies.

Descriptor

Locator type that most often used in PipServices toolkit. It locates components using several fields:

Executor

Helper class that executes components.

Factory

Basic component factory that creates components using registered types and factory functions.

FixedRateTimer

Timer that is triggered in equal time intervals.

ICleanable

Interface for components that should clean their state.

IClosable

Interface for components that require explicit closure.

IConfigurable

An interface to set configuration parameters to an object.

IContext

Interface to specify execution context. see Context

IExecutable

Interface for components that can be called to execute work.

IFactory

Interface for component factories.

INotifiable

Interface for components that can be asynchronously notified. The notification may include optional argument that describe the occured event.

IOpenable

Interface for components that require explicit opening and closing.

IParameterized

Interface for components that require execution parameters.

IReconfigurable

An interface to set configuration parameters to an object.

IReferenceable

Interface for components that depends on other components.

IReferences

Interface for a map that holds component references and passes them to components to establish dependencies with each other.

IUnreferenceable

Interface for components that require explicit clearing of references to dependent components.

NameResolver

A helper class that allows to extract component name from configuration parameters. The name can be defined in 'id', 'name' parameters or inside a component descriptor.

Notifier

Helper class that notifies components.

Opener

Helper class that opens components.

OptionResolver

A helper class to parameters from 'options' configuration section.

Parameters

Contains map with execution parameters.

Reference

Contains a reference to a component and locator to find it. It is used by References to store registered component references.

Referencer

Helper class that sets and unsets references to components.

References

The most basic implementation of IReferences to store and locate component references.

Registration

Exceptions / Errors

CreateException

Error raised when factory is not able to create requested component.

ReferenceException

Error when required component dependency cannot be found.