H Namespace Reference

H namespace. More...

Classes
class	Average
	Class for averaging things out over a number of iterations. More...
class	Debug
	Debug stream class. More...
class	DynamicBuffer
	Implementation of a simple, highly efficient, dynamic buffer. More...
class	DynamicBufferConverter
	Convert a Dynamic buffer to an array of structures or classes. More...
class	Exception
	Generic Exception class. More...
class	DeviceInfo
	Structure to hold information about devices. More...
class	FileWatchee
	Structure to hold information about file watchees. More...
class	FileEventWatcher
	Class to efficiently watch for changes in files. More...
class	DeviceDisconnectException
	Exception that indicates a device has disconnected. More...
class	WatcheeNotFoundException
	Exception that indicates a watchee was not found while iterating. More...
class	SignalHandler
	Main SignalHandler class. More...
class	Socket
	Main Socket class. More...
class	SocketClient
	Main SocketClient class. More...
class	SocketEventWatcher
	Main SocketEventWatcher class. More...
class	SocketException
	Main SocketException class. More...
class	SocketInterface
	Main SocketInterface class. More...
class	SocketServer
	Main SocketServer class. More...
class	stringconverter
	Generic stringconverter class. More...
class	Util
	Main Util class. More...
class	UtilFile
	Main UtilFile class. More...
class	UtilMath
	Main UtilMath class. More...
class	UtilTime
	Main UtilTime class. More...
Enumerations
enum	ExceptionType { EXCEPTION_INFO, EXCEPTION_WARNING, EXCEPTION_NORMAL, EXCEPTION_FATAL }
enum	FileWatchType { WATCH_INVALID = -1, WATCH_IN, WATCH_OUT, WATCH_INOUT }
	Specifies the type of file watching to be done. More...
enum	FileDeviceType { WATCH_POLL, WATCH_INOTIFY }
	Specifies the type of device watching interface (poll / inotify). More...
enum	SocketDomain { SOCKET_INTERNET = PF_INET, SOCKET_UNIX = PF_UNIX, SOCKET_INTERNET2 = PF_INET6 }
	Domain of the socket.
enum	SocketType {   SOCKET_STREAM = SOCK_STREAM, SOCKET_DGRAM = SOCK_DGRAM, SOCKET_RAW = SOCK_RAW, SOCKET_SEQPACKET = SOCK_SEQPACKET,   SOCKET_RDM = SOCK_RDM }
	Type of the socket.
enum	SocketProtocol { SOCKET_PROTO_TCP = IPPROTO_TCP, SOCKET_PROTO_UDP = IPPROTO_UDP }
	Protocol of the socket.
Functions
const Debug &	operator<< (const Debug &dbg, const std::string &s)
	Debug insertion operator for string.
const Debug &	operator<< (const Debug &dbg, const char *s)
	Debug insertion operator for const char *.
const Debug &	operator<< (const Debug &dbg, const char c)
	Debug insertion operator for char.
const Debug &	operator<< (const Debug &dbg, const int d)
	Debug insertion operator for int.
const Debug &	operator<< (const Debug &dbg, const unsigned int d)
	Debug insertion operator for uint.
const Debug &	operator<< (const Debug &dbg, const long l)
	Debug insertion operator for long.
const Debug &	operator<< (const Debug &dbg, const bool b)
	Debug insertion operator for bool.
const Debug &	operator<< (const Debug &dbg, const unsigned long l)
	Debug insertion operator for ulong.
const Debug &	operator<< (const Debug &dbg, const double lf)
	Debug insertion operator for double.
const Debug &	operator<< (const Debug &dbg, std::ostream &(*f)(std::ostream &))
	Debug insertion operator for endl et al.
template<class T>
bool	from_string (T &t, const std::string &s, std::ios_base &(*f)(std::ios_base &))
	Cast a string into another type.
template<class Object, class Functor>
Functor	for_all (Object &object, Functor functor)
	Apply function f to all elements in Object o.
void	dbg_print_item (std::string &object)
	Functor that prints an item using the H:cdbg class.
void	print_item (std::string &object)
	Functor that prints an item.

---

Detailed Description

H namespace.

All code in the H namespace gets its inspiration from the best movie ever made: Hackers

---

Enumeration Type Documentation

enum H::ExceptionType

Enum for the different Exception types

enum H::FileWatchType

Specifies the type of file watching to be done.

WATCH_IN dictates that the file should only be watched for reads WATCH_OUT dictates that the file should only be watched for writes WATCH_INOUT dictates that the file should be watched for reads and writes

enum H::FileDeviceType

Specifies the type of device watching interface (poll / inotify).

WATCH_POLL dictates that the file is a poll device WATCH_INOTIFY dictates that the file is an inotify device

---

Function Documentation

template<class T>

bool H::from_string	(	T &	t,
		const std::string &	s,
		std::ios_base &(*)(std::ios_base &)	f
	)

Cast a string into another type.

Converts various datatypes from string

template<class Object, class Functor>

Functor H::for_all	(	Object &	object,
		Functor	functor
	)			[inline]

Apply function f to all elements in Object o.

Parameters:

	object	The object to apply functor to
	functor	The function that modifies each object

Returns:

result of std::for_each (unary_function)

This is essentially a short cut for std::for_each

void H::dbg_print_item

(

std::string &

object

)

[inline]

Functor that prints an item using the H:cdbg class.

Parameters:

object

The item to print

void H::print_item

(

std::string &

object

)

[inline]

Functor that prints an item.

Parameters:

object

The item to print

---