eq::base Namespace Reference

Detailed Description

Equalizer base OS abstraction layer.

Classes

class Atomic

class BarrierPrivate

class Barrier

A barrier primitive. More...

class Buffer

A simple memory buffer with some helper functions. More...

class Clock

A class for time measurements. More...

class ExecutionListener

A listener interface to monitor execution unit (Thread, Process) state changes. More...

class PtrHash

A hash for pointer keys. More...

struct hashRefPtr

A hash function for RefPtr keys. More...

class RefPtrHash

A hash for RefPtr keys. More...

class IDPool

A identifier pool. More...

class Launcher

The launcher executes a command in a separate process. More...

class LockPrivate

class Lock

A lock (mutex) primitive. More...

class LogTable

class LogBuffer

The string buffer used for logging. More...

class Log

The logging class. More...

class Monitor

A monitor primitive. More...

class MTQueue

A queue with a blocking pop() implementation, typically used between two execution threads. More...

class NonCopyable

Base class for nonCopyable objects. More...

class OMP

Base class abstracting omp. More...

class PerThread

Implements a thread-specific storage for C++ objects. More...

class PerThreadRef

Implements a thread-specific storage for RefPtr's. More...

class Process

An abstraction to create a new execution process. More...

class Referenced

Base class for referenced objects. More...

struct RefPtr_scast

class RefPtr

A smart reference pointer. More...

class RequestHandler

A request handler. More...

class RNG

A random number generator. More...

class ScopedMutex

A scoped mutex. More...

class SemaPrivate

class Sema

A semaphore primitive. More...

class SpinLockPrivate

class SpinLock

A spinlock primitive. More...

class ThreadPrivate

class Thread

An abstraction to create a new execution thread. More...

class TimedLockPrivate

class TimedLock

A timed lock primitive. More...

class TSHash

A thread-safe, lock-free hash. More...

class TSVector

A thread-safe, lock-free vector. More...

Typedefs

typedef Buffer< uint8_t > Bufferb

typedef Monitor< bool > Monitorb

typedef Monitor< uint32_t > Monitoru

Enumerations

enum LogLevel {
LOG_ERROR = 1, LOG_WARN, LOG_INFO, LOG_VERB,
LOG_ALL
}

The logging levels. More...

enum LogTopic { LOG_CUSTOM = 0x10, LOG_ANY = 0xfffu }

The logging topics. More...

Functions

EQ_EXPORT void abortDebug ()

Used to trap into an infinite loop to allow debugging of assertions.

EQ_EXPORT bool init ()

Initializes the Equalizer base classes.

EQ_EXPORT bool exit ()

De-initializes the Equalizer base classes.

EQ_EXPORT std::ostream & indent (std::ostream &os)

The ostream indent manipulator.

EQ_EXPORT std::ostream & exdent (std::ostream &os)

The ostream exdent manipulator.

EQ_EXPORT std::ostream & disableFlush (std::ostream &os)

The ostream flush disable manipulator.

EQ_EXPORT std::ostream & enableFlush (std::ostream &os)

The ostream flush enable manipulator.

EQ_EXPORT std::ostream & forceFlush (std::ostream &os)

The ostream forced flush manipulator.

EQ_EXPORT std::ostream & disableHeader (std::ostream &os)

The ostream header disable manipulator.

EQ_EXPORT std::ostream & enableHeader (std::ostream &os)

The ostream header enable manipulator.

template<class from, class to>

RefPtr< to > RefPtr_static_cast (RefPtr< from > const &f)

template<class T>

std::ostream & operator<< (std::ostream &os, const RefPtr< T > &rp)

void sleep (const uint32_t milliSeconds)

void _notifyStopping (void *arg)

std::ostream & operator<< (std::ostream &os, const Thread *thread)

Enumeration Type Documentation

enum eq::base::LogLevel

The logging levels.

Definition at line 27 of file base/log.h.

enum eq::base::LogTopic

The logging topics.

Definition at line 37 of file base/log.h.

Function Documentation

EQ_EXPORT bool eq::base::init ( )

Initializes the Equalizer base classes.

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

Definition at line 15 of file base/init.cpp.

Referenced by eq::net::init().

Here is the caller graph for this function:

EQ_EXPORT bool eq::base::exit ( )

De-initializes the Equalizer base classes.

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

Definition at line 21 of file base/init.cpp.

References eq::base::Log::exit(), and eq::base::Thread::removeAllListeners().

Referenced by eq::net::exit().

Here is the call graph for this function:

Here is the caller graph for this function:

EQ_EXPORT std::ostream & eq::base::indent ( std::ostream & os )

The ostream indent manipulator.

Definition at line 149 of file log.cpp.

References eq::base::Log::indent().

Here is the call graph for this function:

EQ_EXPORT std::ostream & eq::base::exdent ( std::ostream & os )

The ostream exdent manipulator.

Definition at line 156 of file log.cpp.

References eq::base::Log::exdent().

Here is the call graph for this function:

EQ_EXPORT std::ostream & eq::base::disableFlush ( std::ostream & os )

The ostream flush disable manipulator.

Definition at line 164 of file log.cpp.

References eq::base::Log::disableFlush().

Referenced by eq::net::Node::initLocal(), eq::net::Connection::recv(), and eq::net::Connection::send().

Here is the call graph for this function:

Here is the caller graph for this function:

EQ_EXPORT std::ostream & eq::base::enableFlush ( std::ostream & os )

The ostream flush enable manipulator.

Definition at line 171 of file log.cpp.

References eq::base::Log::enableFlush().

Referenced by eq::net::Node::initLocal(), eq::net::Connection::recv(), and eq::net::Connection::send().

Here is the call graph for this function:

Here is the caller graph for this function:

EQ_EXPORT std::ostream & eq::base::forceFlush ( std::ostream & os )

The ostream forced flush manipulator.

Definition at line 178 of file log.cpp.

References eq::base::Log::forceFlush().

Here is the call graph for this function:

EQ_EXPORT std::ostream & eq::base::disableHeader ( std::ostream & os )

The ostream header disable manipulator.

Definition at line 186 of file log.cpp.

References eq::base::Log::disableHeader().

Here is the call graph for this function:

EQ_EXPORT std::ostream & eq::base::enableHeader ( std::ostream & os )

The ostream header enable manipulator.

Definition at line 193 of file log.cpp.

References eq::base::Log::enableHeader().

Here is the call graph for this function:


Classes
class	Atomic
class	BarrierPrivate
class	Barrier
	A barrier primitive. More...
class	Buffer
	A simple memory buffer with some helper functions. More...
class	Clock
	A class for time measurements. More...
class	ExecutionListener
	A listener interface to monitor execution unit (Thread, Process) state changes. More...
class	PtrHash
	A hash for pointer keys. More...
struct	hashRefPtr
	A hash function for RefPtr keys. More...
class	RefPtrHash
	A hash for RefPtr keys. More...
class	IDPool
	A identifier pool. More...
class	Launcher
	The launcher executes a command in a separate process. More...
class	LockPrivate
class	Lock
	A lock (mutex) primitive. More...
class	LogTable
class	LogBuffer
	The string buffer used for logging. More...
class	Log
	The logging class. More...
class	Monitor
	A monitor primitive. More...
class	MTQueue
	A queue with a blocking pop() implementation, typically used between two execution threads. More...
class	NonCopyable
	Base class for nonCopyable objects. More...
class	OMP
	Base class abstracting omp. More...
class	PerThread
	Implements a thread-specific storage for C++ objects. More...
class	PerThreadRef
	Implements a thread-specific storage for RefPtr's. More...
class	Process
	An abstraction to create a new execution process. More...
class	Referenced
	Base class for referenced objects. More...
struct	RefPtr_scast
class	RefPtr
	A smart reference pointer. More...
class	RequestHandler
	A request handler. More...
class	RNG
	A random number generator. More...
class	ScopedMutex
	A scoped mutex. More...
class	SemaPrivate
class	Sema
	A semaphore primitive. More...
class	SpinLockPrivate
class	SpinLock
	A spinlock primitive. More...
class	ThreadPrivate
class	Thread
	An abstraction to create a new execution thread. More...
class	TimedLockPrivate
class	TimedLock
	A timed lock primitive. More...
class	TSHash
	A thread-safe, lock-free hash. More...
class	TSVector
	A thread-safe, lock-free vector. More...
Typedefs
typedef Buffer< uint8_t >	Bufferb
typedef Monitor< bool >	Monitorb
typedef Monitor< uint32_t >	Monitoru
Enumerations
enum	LogLevel { LOG_ERROR = 1, LOG_WARN, LOG_INFO, LOG_VERB, LOG_ALL }
	The logging levels. More...
enum	LogTopic { LOG_CUSTOM = 0x10, LOG_ANY = 0xfffu }
	The logging topics. More...
Functions
EQ_EXPORT void	abortDebug ()
	Used to trap into an infinite loop to allow debugging of assertions.
EQ_EXPORT bool	init ()
	Initializes the Equalizer base classes.
EQ_EXPORT bool	exit ()
	De-initializes the Equalizer base classes.
EQ_EXPORT std::ostream &	indent (std::ostream &os)
	The ostream indent manipulator.
EQ_EXPORT std::ostream &	exdent (std::ostream &os)
	The ostream exdent manipulator.
EQ_EXPORT std::ostream &	disableFlush (std::ostream &os)
	The ostream flush disable manipulator.
EQ_EXPORT std::ostream &	enableFlush (std::ostream &os)
	The ostream flush enable manipulator.
EQ_EXPORT std::ostream &	forceFlush (std::ostream &os)
	The ostream forced flush manipulator.
EQ_EXPORT std::ostream &	disableHeader (std::ostream &os)
	The ostream header disable manipulator.
EQ_EXPORT std::ostream &	enableHeader (std::ostream &os)
	The ostream header enable manipulator.
template<class from, class to>
RefPtr< to >	RefPtr_static_cast (RefPtr< from > const &f)
template<class T>
std::ostream &	operator<< (std::ostream &os, const RefPtr< T > &rp)
void	sleep (const uint32_t milliSeconds)
void	_notifyStopping (void *arg)
std::ostream &	operator<< (std::ostream &os, const Thread *thread)