Utility Classes

This category includes utility classes which can be used by others. More...

Classes
class	Any
	An Any class represents a general type and is capable of storing any type, supporting type-safe extraction of the internally stored data. More...
class	LDAPProp
	A fluent API for creating LDAP filter strings. More...
class	SharedData
class	SharedDataPointer< T >
class	ExplicitlySharedDataPointer< T >
class	SharedLibrary
	The SharedLibrary class loads shared libraries at runtime. More...
class	ShrinkableMap< Key, T >
	A std::map style associative container allowing query and removal operations only. More...
class	ShrinkableVector< E >
	A std::vector style container allowing query and removal operations only. More...

Typedefs
typedef void(*	MsgHandler) (MsgType, const char *)
	A message handler callback function. More...

Enumerations
enum	MsgType { DebugMsg, InfoMsg, WarningMsg, ErrorMsg }
	This enum describes the messages that can be sent to a message handler (MsgHandler). More...

Functions
us::LDAPPropExpr	operator&& (const us::LDAPPropExpr &left, const us::LDAPPropExpr &right)
	LDAP logical and '&'. More...
us::LDAPPropExpr	operator|| (const us::LDAPPropExpr &left, const us::LDAPPropExpr &right)
	LDAP logical or '|'. More...
MsgHandler	installMsgHandler (MsgHandler)
	Installs a message handler which has been defined previously. More...

Detailed Description

This category includes utility classes which can be used by others.

Typedef Documentation

MsgHandler

A message handler callback function.

Enumeration Type Documentation

enum MsgType

This enum describes the messages that can be sent to a message handler (MsgHandler).

You can use the enum to identify and associate the various message types with the appropriate actions.

Enumerator
DebugMsg	A debug message.
InfoMsg	An informational message.
WarningMsg	A warning message.
ErrorMsg	An error message.

Function Documentation

MsgHandler installMsgHandler

(

MsgHandler

)

Installs a message handler which has been defined previously.

Returns a pointer to the previous message handler (which may be 0).

The message handler is a function that prints out debug messages, warnings, and fatal error messages. The C++ Micro Services library (debug mode) contains warning messages that are printed when internal errors (usually invalid function arguments) occur. The library built in release mode also contains such warnings unless US_NO_WARNING_OUTPUT has been set during compilation. In both debug and release mode debugging message are suppressed by default, unless US_ENABLE_DEBUGGING_OUTPUT has been set during compilation. If you implement your own message handler, you get total control of these messages.

The default message handler prints the message to the standard output. If it is an error message, the application aborts immediately.

Only one message handler can be defined, since this is usually done on an application-wide basis to control debug output.

To restore the message handler, call installMsgHandler(0).

us::LDAPPropExpr operator&&	(	const us::LDAPPropExpr &	left,
		const us::LDAPPropExpr &	right
	)

LDAP logical and '&'.

Parameters

left	A LDAP expression.
right	A LDAP expression.

Returns

A LDAP expression

us::LDAPPropExpr operator||	(	const us::LDAPPropExpr &	left,
		const us::LDAPPropExpr &	right
	)

LDAP logical or '|'.

Parameters

left	A LDAP expression.
right	A LDAP expression.

Returns

A LDAP expression