/home/serif/byzantine_generals/src/sharedmemtypes.h

Go to the documentation of this file.

/**
 * @file sharedmemtypes.h
 * @author Reshen Amin <reshen@zensrc.com>
 *
 * @brief Contains the types used as part of shared memory access
 *
 * @license Byzantine Generals Problem Coding Sample.<br>
 * Copyright (C) 2010  Reshen Amin.<br>
 * See @ref license_sec for details.<br>
 */

#ifndef SRC_SHAREDMEMTYPES_H_
#define SRC_SHAREDMEMTYPES_H_

#include <boost/interprocess/managed_shared_memory.hpp>
#include <boost/interprocess/containers/vector.hpp>
#include <boost/interprocess/containers/string.hpp>
#include <boost/interprocess/allocators/allocator.hpp>
#include <boost/interprocess/containers/list.hpp>
#include <boost/interprocess/containers/set.hpp>

#include <functional>

/**
 * @brief  Convenience typedef to Boost's Interprocess shared memory segment
 */
typedef boost::interprocess::managed_shared_memory::segment_manager
    SharedMemorySegmentManager;

/**
 * @brief  A Boost Interprocess character allocator which allocates using
 * @ref SharedMemorySegmentManager
 */
typedef boost::interprocess::allocator<char, SharedMemorySegmentManager>
    SharedMemoryCharAllocator;

/**
 * @brief  A Boost Interprocess unsigned int allocator which allocates using
 * @ref SharedMemorySegmentManager
 */
typedef boost::interprocess::allocator<unsigned int, SharedMemorySegmentManager>
    SharedMemoryUIntAllocator;

/**
 * @brief  A Boost Interprocess basic_string which allocates characters using
 * @ref SharedMemoryCharAllocator
 */
typedef boost::interprocess::basic_string<char,
                                          std::char_traits<char>,
                                          SharedMemoryCharAllocator>
                                          SharedMemoryString;

/* Forward declaration used in subsequent typedefs */
class Mailbox;

/**
 * @brief  A Boost Interprocess @ref Mailbox allocator which allocates using
 * @ref SharedMemorySegmentManager
 */
typedef boost::interprocess::allocator<Mailbox *, SharedMemorySegmentManager>
    SharedMemoryMailboxAllocator;

/**
 * @brief  A Boost Interprocess @ref Mailbox vector which allocates using
 * @ref SharedMemoryMailboxAllocator
 */
typedef boost::interprocess::vector<Mailbox *, SharedMemoryMailboxAllocator>
    SharedMemoryMailboxVector;


/* Forward declaration used in subsequent typedefs */
class Order;

/**
 * @brief  A Boost Interprocess @ref Order allocator which allocates using
 * @ref SharedMemorySegmentManager
 */
typedef boost::interprocess::allocator<Order, SharedMemorySegmentManager>
    OrderAllocator;

/**
 * @brief  A Boost Interprocess @ref Order list which allocates using
 * @ref OrderAllocator
 */
typedef boost::interprocess::list<Order, OrderAllocator>
    OrderList;

/**
 * @brief  A Boost Interprocess unsigned int list which allocates using
 * @ref SharedMemoryUIntAllocator
 */
typedef boost::interprocess::list<unsigned int, SharedMemoryUIntAllocator>
    SharedMemoryUIntList;

/**
 * @brief  A Boost Interprocess unsigned int set which allocates using
 * @ref SharedMemoryUIntAllocator
 */
typedef boost::interprocess::set<unsigned int,
                                 std::less<unsigned int>,
                                 SharedMemoryUIntAllocator>
                                 SharedMemoryUIntSet;

#endif  // SRC_SHAREDMEMTYPES_H_

---