The Equalizer administrative library. More...

Classes
class	Canvas
class	Channel
class	Client
	The client represents the admin tool as a co::Node to the cluster. More...
class	Config
class	Layout
class	Node
class	Observer
class	Pipe
class	Segment
class	Server
	Proxy object for the connection to an Equalizer server. More...
class	View
class	Window
Functions
EQADMIN_API bool	init (const int argc, char **argv)
	Initialize the Equalizer administrative library.
EQADMIN_API bool	exit ()
	De-initialize the Equalizer administrative library.
Typedefs
typedef co::base::RefPtr< Client >	ClientPtr
typedef co::base::RefPtr < const Client >	ConstClientPtr
typedef co::base::RefPtr< Server >	ServerPtr
typedef fabric::LeafVisitor < Segment >	SegmentVisitor
	A visitor to traverse segments.
typedef fabric::LeafVisitor< View >	ViewVisitor
	A visitor to traverse views.
typedef fabric::LeafVisitor < Observer >	ObserverVisitor
	A visitor to traverse channels.
typedef fabric::LeafVisitor < Channel >	ChannelVisitor
	A visitor to traverse channels.
typedef fabric::ElementVisitor < Canvas, SegmentVisitor >	CanvasVisitor
	A visitor to traverse Canvas and children.
typedef fabric::ElementVisitor < Window, ChannelVisitor >	WindowVisitor
	A visitor to traverse windows and children.
typedef fabric::ElementVisitor < Pipe, WindowVisitor >	PipeVisitor
	A visitor to traverse pipes and children.
typedef fabric::ElementVisitor < Node, PipeVisitor >	NodeVisitor
	A visitor to traverse nodes and children.
typedef fabric::ElementVisitor < Layout, ViewVisitor >	LayoutVisitor
	A visitor to traverse layouts and children.
typedef fabric::ConfigVisitor < Config, ObserverVisitor, LayoutVisitor, CanvasVisitor, NodeVisitor >	ConfigVisitor
	A visitor to traverse configs and children.
typedef std::vector< Config * >	Configs
	A vector of pointers to eq::admin::Config.
typedef std::vector< Node * >	Nodes
	A vector of pointers to eq::admin::Node.
typedef std::vector< Pipe * >	Pipes
	A vector of pointers to eq::admin::Pipe.
typedef std::vector< Window * >	Windows
	A vector of pointers to eq::admin::Window.
typedef std::vector< Channel * >	Channels
	A vector of pointers to eq::admin::Channel.
typedef std::vector< Observer * >	Observers
	A vector of pointers to eq::admin::Observer.
typedef std::vector< Canvas * >	Canvass
	A vector of pointers to eq::admin::Canvas.
typedef std::vector< Layout * >	Layouts
	A vector of pointers to eq::admin::Layout.
typedef std::vector< Segment * >	Segments
	A vector of pointers to eq::admin::Segment.
typedef std::vector< View * >	Views
	A vector of pointers to eq::admin::View.
typedef co::base::uint128_t	uint128_t
typedef fabric::VisitorResult	VisitorResult
	The result code from any visit operation.

Detailed Description

The Equalizer administrative library.

This namespace implements the administrative interface to the Equalizer server. It can be used in coexistence with the client library in the same application.

The administrative interface allows to query and modify the settings of Equalizer servers, including the modification of a running configuration. An administrative application connects to a Server, which will create a proxy of the server configuration. This proxy can be sync'ed, modified and commit'ed to track changes, change a configuration and activate the modifications, respectively.

Function Documentation

EQADMIN_API bool eq::admin::exit ( )

De-initialize the Equalizer administrative library.

De-initialize the Equalizer base classes.

This function also de-initializes the network layer, if the Equalizer client library is not initialized.

Returns:: true if the library was successfully de-initialized, false otherwise.

EQADMIN_API bool eq::admin::init	(	const int	argc,
		char **	argv
	)		`[inline]`

Initialize the Equalizer administrative library.

Initialize the Equalizer base classes.

This function also initializes the network layer using co::init(), if eq::init() was not called beforehand by the calling process. It has to be called before any other access to classes or functions in this namespace. It can be called before or after eq::init().

Parameters: