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

Typedefs
typedef lunchbox::RefPtr< Client >	ClientPtr

typedef lunchbox::RefPtr < const Client >	ConstClientPtr

typedef lunchbox::RefPtr< Server >	ServerPtr

typedef fabric::LeafVisitor < Segment >	SegmentVisitor
	A visitor to traverse segments. More...

typedef fabric::LeafVisitor< View >	ViewVisitor
	A visitor to traverse views. More...

typedef fabric::LeafVisitor < Observer >	ObserverVisitor
	A visitor to traverse channels. More...

typedef fabric::LeafVisitor < Channel >	ChannelVisitor
	A visitor to traverse channels. More...

typedef fabric::ElementVisitor < Canvas, SegmentVisitor >	CanvasVisitor
	A visitor to traverse Canvas and children. More...

typedef fabric::ElementVisitor < Window, ChannelVisitor >	WindowVisitor
	A visitor to traverse windows and children. More...

typedef fabric::ElementVisitor < Pipe, WindowVisitor >	PipeVisitor
	A visitor to traverse pipes and children. More...

typedef fabric::ElementVisitor < Node, PipeVisitor >	NodeVisitor
	A visitor to traverse nodes and children. More...

typedef fabric::ElementVisitor < Layout, ViewVisitor >	LayoutVisitor
	A visitor to traverse layouts and children. More...

typedef fabric::ConfigVisitor < Config, ObserverVisitor, LayoutVisitor, CanvasVisitor, NodeVisitor >	ConfigVisitor
	A visitor to traverse configs and children. More...

typedef fabric::ElementVisitor < Server, ConfigVisitor >	ServerVisitor
	A visitor to traverse servers and children. More...

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 lunchbox::uint128_t	uint128_t

typedef lunchbox::VisitorResult	VisitorResult
	The result code from any visit operation. More...

Functions
EQADMIN_API bool	init (const int argc, char **argv)
	Initialize the Equalizer administrative library. More...

EQADMIN_API bool	exit ()
	De-initialize the Equalizer administrative library. More...

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.

Typedef Documentation

typedef fabric::ElementVisitor< Canvas, SegmentVisitor > eq::admin::CanvasVisitor

A visitor to traverse Canvas and children.

Definition at line 68 of file admin/types.h.

typedef fabric::LeafVisitor< Channel > eq::admin::ChannelVisitor

A visitor to traverse channels.

See Also: Channel::accept()

Definition at line 65 of file admin/types.h.

typedef fabric::ConfigVisitor< Config, ObserverVisitor, LayoutVisitor, CanvasVisitor, NodeVisitor > eq::admin::ConfigVisitor

A visitor to traverse configs and children.

Definition at line 85 of file admin/types.h.

typedef fabric::ElementVisitor< Layout, ViewVisitor > eq::admin::LayoutVisitor

A visitor to traverse layouts and children.

Definition at line 80 of file admin/types.h.

typedef fabric::ElementVisitor< Node, PipeVisitor > eq::admin::NodeVisitor

A visitor to traverse nodes and children.

Definition at line 77 of file admin/types.h.

typedef fabric::LeafVisitor< Observer > eq::admin::ObserverVisitor

A visitor to traverse channels.

See Also: Channel::accept()

Definition at line 62 of file admin/types.h.

typedef fabric::ElementVisitor< Pipe, WindowVisitor > eq::admin::PipeVisitor

A visitor to traverse pipes and children.

Definition at line 74 of file admin/types.h.

typedef fabric::LeafVisitor< Segment > eq::admin::SegmentVisitor

A visitor to traverse segments.

See Also: Segment::accept()

Definition at line 56 of file admin/types.h.

typedef fabric::ElementVisitor< Server, ConfigVisitor > eq::admin::ServerVisitor

A visitor to traverse servers and children.

Definition at line 88 of file admin/types.h.

typedef fabric::LeafVisitor< View > eq::admin::ViewVisitor

A visitor to traverse views.

See Also: View::accept()

Definition at line 59 of file admin/types.h.

typedef lunchbox::VisitorResult eq::admin::VisitorResult

The result code from any visit operation.

Definition at line 28 of file admin/visitorResult.h.

typedef fabric::ElementVisitor< Window, ChannelVisitor > eq::admin::WindowVisitor

A visitor to traverse windows and children.

Definition at line 71 of file admin/types.h.

Function Documentation

EQADMIN_API bool eq::admin::exit ( )

De-initialize the Equalizer administrative library.

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
	)

Initialize the Equalizer administrative library.

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

argc	the command line argument count.
argv	the command line argument values.

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

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation