Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_MMAP_Memory_Pool_Options Class Reference

Helper class for MMAP Memory Pool constructor options. More...

#include <MMAP_Memory_Pool.h>

List of all members.

Public Types

enum  { FIRSTCALL_FIXED = 0, ALWAYS_FIXED = 1, NEVER_FIXED = 2 }

Public Member Functions

 ACE_MMAP_Memory_Pool_Options (const void *base_addr=ACE_DEFAULT_BASE_ADDR, int use_fixed_addr=ALWAYS_FIXED, int write_each_page=1, size_t minimum_bytes=0, u_int flags=0, int guess_on_fault=1, LPSECURITY_ATTRIBUTES sa=0, mode_t file_mode=ACE_DEFAULT_FILE_PERMS, bool unique_=false)

Public Attributes

const void * base_addr_
 Base address of the memory-mapped backing store.

int use_fixed_addr_
int write_each_page_
size_t minimum_bytes_
 What the minimim bytes of the initial segment should be.

u_int flags_
 Any special flags that need to be used for mmap.

bool guess_on_fault_
LPSECURITY_ATTRIBUTES sa_
 Pointer to a security attributes object. Only used on NT.

mode_t file_mode_
 File mode for mmaped file, if it is created.

bool unique_
 Do we want an unique backing store name?


Private Member Functions

 ACE_MMAP_Memory_Pool_Options (const ACE_MMAP_Memory_Pool_Options &)
ACE_MMAP_Memory_Pool_Options & operator= (const ACE_MMAP_Memory_Pool_Options &)

Detailed Description

Helper class for MMAP Memory Pool constructor options.

This should be a nested class, but that breaks too many compilers.

Definition at line 40 of file MMAP_Memory_Pool.h.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
FIRSTCALL_FIXED  The base address from the first call to mmap will be used for subsequent calls to mmap.
ALWAYS_FIXED  The base address specified in base_addr will be used in all calls to mmap.
NEVER_FIXED  The base address will be selected by the OS for each call to mmap. Caution should be used with this mode since a call that requires the backing store to grow may change pointers that are cached by the application.

Definition at line 43 of file MMAP_Memory_Pool.h. 

00044   {
00045     /**
00046      * The base address from the first call to mmap will be used for subsequent
00047      * calls to mmap.
00048      */
00049     FIRSTCALL_FIXED = 0,
00050 
00051     /**
00052      * The base address specified in base_addr will be used in all calls to
00053      * mmap.
00054      */
00055     ALWAYS_FIXED = 1,
00056 
00057     /**
00058      * The base address will be selected by the OS for each call to mmap.
00059      * Caution should be used with this mode since a call that requires the
00060      * backing store to grow may change pointers that are cached by the
00061      * application.
00062      */
00063     NEVER_FIXED = 2
00064   };

Constructor & Destructor Documentation

ACE_MMAP_Memory_Pool_Options::ACE_MMAP_Memory_Pool_Options (  const void *  base_addr = ACE_DEFAULT_BASE_ADDR,
int  use_fixed_addr = ALWAYS_FIXED,
int  write_each_page = 1,
size_t  minimum_bytes = 0,
u_int  flags = 0,
int  guess_on_fault = 1,
LPSECURITY_ATTRIBUTES  sa = 0,
mode_t  file_mode = ACE_DEFAULT_FILE_PERMS,
bool  unique_ = false
) 
 

Definition at line 438 of file MMAP_Memory_Pool.cpp.

References ACE_TRACE, ALWAYS_FIXED, FIRSTCALL_FIXED, mode_t, and use_fixed_addr_. 

00448   : base_addr_ (base_addr),
00449     use_fixed_addr_ (use_fixed_addr),
00450     write_each_page_ (write_each_page),
00451     minimum_bytes_ (minimum_bytes),
00452     flags_ (flags),
00453     guess_on_fault_ (guess_on_fault),
00454     sa_ (sa),
00455     file_mode_ (file_mode),
00456     unique_ (unique)
00457 {
00458   ACE_TRACE ("ACE_MMAP_Memory_Pool_Options::ACE_MMAP_Memory_Pool_Options");
00459   // for backwards compatability
00460   if (base_addr_ == 0 && use_fixed_addr_ == ALWAYS_FIXED)
00461     use_fixed_addr_ = FIRSTCALL_FIXED;
00462 }

ACE_MMAP_Memory_Pool_Options::ACE_MMAP_Memory_Pool_Options (  const ACE_MMAP_Memory_Pool_Options &   )  [private]
 

Member Function Documentation

ACE_MMAP_Memory_Pool_Options& ACE_MMAP_Memory_Pool_Options::operator= (  const ACE_MMAP_Memory_Pool_Options &   )  [private]
 

Member Data Documentation

const void* ACE_MMAP_Memory_Pool_Options::base_addr_
 

Base address of the memory-mapped backing store.

Definition at line 78 of file MMAP_Memory_Pool.h.

mode_t ACE_MMAP_Memory_Pool_Options::file_mode_
 

File mode for mmaped file, if it is created.

Definition at line 115 of file MMAP_Memory_Pool.h.

u_int ACE_MMAP_Memory_Pool_Options::flags_
 

Any special flags that need to be used for mmap.

Definition at line 102 of file MMAP_Memory_Pool.h.

bool ACE_MMAP_Memory_Pool_Options::guess_on_fault_
 

Try to remap without knowing the faulting address. This parameter is ignored on platforms that know the faulting address (UNIX with SI_ADDR and Win32).

Definition at line 109 of file MMAP_Memory_Pool.h.

size_t ACE_MMAP_Memory_Pool_Options::minimum_bytes_
 

What the minimim bytes of the initial segment should be.

Definition at line 99 of file MMAP_Memory_Pool.h.

LPSECURITY_ATTRIBUTES ACE_MMAP_Memory_Pool_Options::sa_
 

Pointer to a security attributes object. Only used on NT.

Definition at line 112 of file MMAP_Memory_Pool.h.

bool ACE_MMAP_Memory_Pool_Options::unique_
 

Do we want an unique backing store name?

Definition at line 118 of file MMAP_Memory_Pool.h.

int ACE_MMAP_Memory_Pool_Options::use_fixed_addr_
 

Determines whether we set base_addr_ or if mmap(2) selects it FIRSTCALL_FIXED The base address from the first call to mmap will be used for subsequent calls to mmap ALWAYS_FIXED The base address specified in base_addr will be used in all calls to mmap. NEVER_FIXED The base address will be selected by the OS for each call to mmap. Caution should be used with this mode since a call that requires the backing store to grow may change pointers that are cached by the application.

Definition at line 92 of file MMAP_Memory_Pool.h.

Referenced by ACE_MMAP_Memory_Pool_Options().

int ACE_MMAP_Memory_Pool_Options::write_each_page_
 

Should each page be written eagerly to avoid surprises later on?

Definition at line 96 of file MMAP_Memory_Pool.h.

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 12:55:54 2008 for ACE by doxygen 1.3.6