copland.lib

This package contains additional services, providing functionality beyond that given by the core set of services in Copland itself. These additional services include a multicast service factory, a synchronizing interceptor, and more.

Service Points

Service Points

BlockingInterceptor (singleton)

Blocks access to certain messages, effectively limiting the interface of the service it wraps. The definition of the interceptor can specify the behavior when a blocked message is intercepted, either failing silently, or raising an exception.

Implementor

copland/lib/blocking-interceptor/Copland::Library::BlockingInterceptorFactory

Schema

behavior [string]
This should be either "silent", or the name of an exception to raise. It describes the behavior to select when a message is blocked. It defaults to "NoMethodError".

ClassBuilderFactory (singleton)

This is just like BuilderFactory, but it works on classes instead of objects. That is to say, instead of instantiating an object, it instead just returns a class reference. This is useful for backing a service with a class instead of an object.

Implementor

copland/lib/class-builder-factory/Copland::Library::ClassBuilderFactory

Schema

class [string] (required)
That path to class to return. This has the same format as for BuilderFactory.
initialize-method [string]
This describes the name of the (class) method to invoke when the service has been completely initialized (and all properties wired into it). This defaults to "initialize_service". If the method does not exist, then nothing is invoked.
properties [hash]
A hash of properties to set on the class. First, setters are searched for, of the format "name=" or "set_name". If one is found, it will be invoked. Otherwise, the properties are set directly using "class_eval".

ENVSymbolSource (singleton)

A symbol source that draws its values from the ENV hash. This source is not made available by default--applications wishing to use it must manually add it to the copland.SymbolSources configuration point.

Implementor

copland/lib/env-symbol-source/Copland::Library::ENVSymbolSource

MulticastFactory (singleton)

A specialized builder factory for constructing a multicast service. A multicast service is one which will forward any messages it recieves to all registered targets.

Implementor

copland/lib/multicast-factory/Copland::Library::MulticastFactory

Schema

targets [configuration] (required)
This must be a 'list' configuration point, where each element in the list must be a service to forward messages to.

RedirectingInterceptor (singleton)

Redirects incoming messages, so that a message A might get rerouted to message B. You can do more complex redirections as well, specifying a regular expression and a replacement pattern. Any message not matching one of the patterns will be routed through, unchanged.

Implementor

copland/lib/redirecting-interceptor/Copland::Library::RedirectingInterceptorFactory

Schema

redirect [any] (required)
This should be either a hash or a map configuration point that defines the mappings for redirection. Each key should be a regular expression (implicitly wrapped in "^(.*)$"), and the value should be a string (possibly containing literals of the form "\1", for substituting the corresponding subgroup in the pattern).

RubySymbolSource (singleton)

A symbol source that draws its values from the Config::CONFIG hash. This source is not made available by default--applications wishing to use it must manually add it to the copland.SymbolSources configuration point.

Implementor

copland/lib/ruby-symbol-source/Copland::Library::RubySymbolSource

SynchronizingInterceptor (singleton)

An interceptor that wraps each invocation of a service's methods inside a mutex's synchronization block. Each method is protected by its own mutex.

Implementor

copland/lib/synchronizing-interceptor/Copland::Library::SynchronizingInterceptorFactory

Schema

copland.IncludeExcludeSchema
Generated by Copland's Packrat documentation extractor on Mon Oct 11 20:22:31 MDT 2004