## NAME

ACE_MMAP_Memory_Pool_Options - Helper class for MMAP Memory Pool constructor options.

## SYNOPSIS

    #include <ace/ACE_Memory_Pool.h>

    class ACE_MMAP_Memory_Pool_Options
    {
      public:
        ACE_MMAP_Memory_Pool_Options (
            void *base_addr = ACE_DEFAULT_BASE_ADDR,
            int use_fixed_addr = 1,
            int write_each_page = 1,
            off_t minimum_bytes = 0,
            u_int flags = 0,
            int guess_on_fault = 1,
            LPSECURITY_ATTRIBUTES sa = 0
            );
        void *base_addr_;
        int use_fixed_addr_;
        int write_each_page_;
        off_t minimum_bytes_;
        u_int flags_;
        int guess_on_fault_;
        LPSECURITY_ATTRIBUTES sa_;
    };

## DESCRIPTION

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

## Initialization method.

    ACE_MMAP_Memory_Pool_Options (
        void *base_addr = ACE_DEFAULT_BASE_ADDR,
        int use_fixed_addr = 1,
        int write_each_page = 1,
        off_t minimum_bytes = 0,
        u_int flags = 0,
        int guess_on_fault = 1,
        LPSECURITY_ATTRIBUTES sa = 0
        );

    void *base_addr_;

Base address of the memory-mapped backing store.

    int use_fixed_addr_;

Must we use the `base_addr_` or can we let mmap(2) select it?

    int write_each_page_;

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

    off_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`.

    int 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).

    LPSECURITY_ATTRIBUTES sa_;

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

## AUTHOR

Doug Schmidt and Prashant Jain

## LIBRARY

ace