Defines | Functions | Variables

Configuration constants, macros and utility functions.

Defines

#define HAMCAST_MACOS
#define HAMCAST_LINUX
#define HAMCAST_WINDOWS
#define HAMCAST_64BIT

Functions

std::string hamcast::version_string ()

Variables

static const boost::uint32_t hamcast::magic_number = 0xDEADC0DE
static const boost::uint32_t hamcast::major_version = 0
static const boost::uint32_t hamcast::minor_version = 4
static const boost::uint32_t hamcast::min_compatile_major_version = 0
static const boost::uint32_t hamcast::min_compatile_minor_version = 3
static const size_t hamcast::default_max_buffer_size = 16 * 1024 * 1024
static const size_t hamcast::default_block_size = 512
static const size_t hamcast::max_pending_sends = 256
static const size_t hamcast::max_buffered_sends = 512
static const size_t hamcast::min_buffer_chunk = default_max_buffer_size / max_buffered_sends
static const size_t hamcast::max_ack_block_size = 64
static const size_t hamcast::force_ack_us_interval = 5000
static const size_t hamcast::default_max_write_buffer_size = (1024 * 1024 * 5)
static const char * hamcast::meeting_point = "/tmp/hamcast/meeting_point/middleware/"
static const char * hamcast::lock_filename = "middleware.lock_file"
static const char * hamcast::config_filename = "middleware.config_file"

Define Documentation

#define HAMCAST_64BIT

This macro is defined, if the host is running a 64-bit system.

#define HAMCAST_LINUX

This macro is defined, if the host is running Linux.

#define HAMCAST_MACOS

This macro is defined, if the host is running Mac OS X.

#define HAMCAST_WINDOWS

This macro is defined, if the host is running Windows.


Function Documentation

std::string hamcast::version_string (  ) 

Utility function to get the library version as string in the format {major_version}.{minor_version}.

Returns:
The HAMcast version as string.

Variable Documentation

const char* hamcast::config_filename = "middleware.config_file" [static]

The filename of the middleware config file.

const size_t hamcast::default_block_size = 512 [static]

The default chunk/block size for IO buffers.

Note:
This constant is used by util::buffered_sink.
const size_t hamcast::default_max_buffer_size = 16 * 1024 * 1024 [static]

The default maximum buffer size (16MB).

const size_t hamcast::default_max_write_buffer_size = (1024 * 1024 * 5) [static]

The default maximum size of for IO buffers (5MB).

Note:
This constant is used by util::buffered_sink.
const size_t hamcast::force_ack_us_interval = 5000 [static]

The time interval of forced acknowledgements in microseconds.

Default is 5ms.

const char* hamcast::lock_filename = "middleware.lock_file" [static]

The filename of the middleware lock file.

const boost::uint32_t hamcast::magic_number = 0xDEADC0DE [static]

The HAMcast magic number.

const boost::uint32_t hamcast::major_version = 0 [static]

The major version of the library.

const size_t hamcast::max_ack_block_size = 64 [static]

The maximum number of cumulative acknowledged messages.

const size_t hamcast::max_buffered_sends = 512 [static]

The maximum number of buffered asynchronous send messages.

Note:
Should be factor of default_max_buffer_size.
const size_t hamcast::max_pending_sends = 256 [static]

The maximum number of pending asynchronous send messages.

const char* hamcast::meeting_point = "/tmp/hamcast/meeting_point/middleware/" [static]

The path of the meeting point.

The meeting point is a directory where the middleware stores all config parameters needed by client applications.

const size_t hamcast::min_buffer_chunk = default_max_buffer_size / max_buffered_sends [static]

Deduced from default_max_buffer_size and max_buffered_sends.

const boost::uint32_t hamcast::min_compatile_major_version = 0 [static]

The minimum major version that is (IPC) compatible to this version.

const boost::uint32_t hamcast::min_compatile_minor_version = 3 [static]

The minimum minor version that is (IPC) compatible to this version.

const boost::uint32_t hamcast::minor_version = 4 [static]

The minor version of the library.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator