1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
|
.TH ACE_PI_Control_Block 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_PI_Control_Block \- This information is stored in memory allocated by the <Memory_Pool>.
.SH SYNOPSIS
.br
.PP
\fC#include <PI_Malloc.h>\fR
.PP
.SS Public Types
.in +1c
.ti -1c
.RI "typedef \fBACE_Based_Pointer\fR<\fBACE_Malloc_Header\fR> \fBMALLOC_HEADER_PTR\fR"
.br
.ti -1c
.RI "typedef \fBACE_Based_Pointer\fR<\fBACE_Name_Node\fR> \fBNAME_NODE_PTR\fR"
.br
.ti -1c
.RI "typedef \fBACE_Based_Pointer_Basic\fR<char> \fBCHAR_PTR\fR"
.br
.in -1c
.SS Public Methods
.in +1c
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of the object.\fR"
.in -1c
.SS Public Attributes
.in +1c
.ti -1c
.RI "int \fBref_counter_\fR"
.br
.RI "\fIReference counter.\fR"
.ti -1c
.RI "\fBNAME_NODE_PTR\fR \fBname_head_\fR"
.br
.RI "\fIHead of the linked list of Name Nodes.\fR"
.ti -1c
.RI "\fBMALLOC_HEADER_PTR\fR \fBfreep_\fR"
.br
.RI "\fICurrent head of the freelist.\fR"
.ti -1c
.RI "char \fBlock_name_\fR [MAXNAMELEN]"
.br
.RI "\fIName of lock thats ensures mutual exclusion.\fR"
.ti -1c
.RI "long \fBalign_\fR [ACE_PI_CONTROL_BLOCK_ALIGN_LONGS < 1 ? 1 : ACE_PI_CONTROL_BLOCK_ALIGN_LONGS]"
.br
.RI "\fIForce alignment.\fR"
.ti -1c
.RI "\fBACE_Malloc_Header\fR \fBbase_\fR"
.br
.RI "\fIDummy node used to anchor the freelist. This needs to come last...\fR"
.in -1c
.SS Static Public Methods
.in +1c
.ti -1c
.RI "void \fBprint_alignment_info\fR (void)"
.br
.RI "\fIPrint out a bunch of size info for debugging.\fR"
.in -1c
.SS Private Methods
.in +1c
.ti -1c
.RI "void \fBoperator=\fR (const \fBACE_Control_Block\fR &)"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
This information is stored in memory allocated by the <Memory_Pool>.
.PP
.PP
This class implements the control block structure that can be used in a "position indepent" fashion, i.e., you don't need to "map" the underlying memory pool to the same address in processes sharing the memory. The tradoff of this flexibility is more expensive malloc/free operations.
.PP
.SH MEMBER TYPEDEF DOCUMENTATION
.PP
.SS typedef \fBACE_Based_Pointer_Basic\fR<char> ACE_PI_Control_Block::CHAR_PTR
.PP
.SS typedef \fBACE_Based_Pointer\fR<\fBACE_Malloc_Header\fR> ACE_PI_Control_Block::MALLOC_HEADER_PTR
.PP
.SS typedef \fBACE_Based_Pointer\fR<\fBACE_Name_Node\fR> ACE_PI_Control_Block::NAME_NODE_PTR
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS void ACE_PI_Control_Block::dump (void) const
.PP
Dump the state of the object.
.PP
.SS void ACE_PI_Control_Block::operator= (const \fBACE_Control_Block\fR &)\fC [private]\fR
.PP
.SS void ACE_PI_Control_Block::print_alignment_info (void)\fC [static]\fR
.PP
Print out a bunch of size info for debugging.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS long ACE_PI_Control_Block::align_[ACE_PI_CONTROL_BLOCK_ALIGN_LONGS< 1?1:ACE_PI_CONTROL_BLOCK_ALIGN_LONGS]
.PP
Force alignment.
.PP
.SS \fBACE_Malloc_Header\fR ACE_PI_Control_Block::base_
.PP
Dummy node used to anchor the freelist. This needs to come last...
.PP
.SS \fBMALLOC_HEADER_PTR\fR ACE_PI_Control_Block::freep_
.PP
Current head of the freelist.
.PP
.SS char ACE_PI_Control_Block::lock_name_[MAXNAMELEN]
.PP
Name of lock thats ensures mutual exclusion.
.PP
.SS \fBNAME_NODE_PTR\fR ACE_PI_Control_Block::name_head_
.PP
Head of the linked list of Name Nodes.
.PP
.SS int ACE_PI_Control_Block::ref_counter_
.PP
Reference counter.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|