File: ACE_Shared_Memory_MM.3

package info (click to toggle)
ace 5.2.1-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 26,856 kB
  • ctags: 18,677
  • sloc: cpp: 171,831; makefile: 48,840; sh: 10,192; perl: 8,582; exp: 787; yacc: 387; lex: 140; csh: 20
file content (168 lines) | stat: -rw-r--r-- 5,306 bytes parent folder | download
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
.TH ACE_Shared_Memory_MM 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Shared_Memory_MM \- Shared memory wrapper based on MMAP. 
.SH SYNOPSIS
.br
.PP
\fC#include <Shared_Memory_MM.h>\fR
.PP
Inherits \fBACE_Shared_Memory\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_Shared_Memory_MM\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.ti -1c
.RI "\fBACE_Shared_Memory_MM\fR (ACE_HANDLE handle, int length = -1, int prot = PROT_RDWR, int share = ACE_MAP_PRIVATE, char *addr = 0, off_t pos = 0)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "\fBACE_Shared_Memory_MM\fR (const \fBACE_TCHAR\fR *file_name, int len = -1, int flags = O_RDWR | O_CREAT, int mode = ACE_DEFAULT_FILE_PERMS, int prot = PROT_RDWR, int share = ACE_MAP_SHARED, char *addr = 0, off_t pos = 0)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "int \fBopen\fR (ACE_HANDLE handle, int length = -1, int prot = PROT_RDWR, int share = ACE_MAP_PRIVATE, char *addr = 0, off_t pos = 0)"
.br
.RI "\fIOpen method.\fR"
.ti -1c
.RI "int \fBopen\fR (const \fBACE_TCHAR\fR *file_name, int len = -1, int flags = O_RDWR | O_CREAT, int mode = ACE_DEFAULT_FILE_PERMS, int prot = PROT_RDWR, int share = ACE_MAP_SHARED, char *addr = 0, off_t pos = 0)"
.br
.RI "\fIOpen method.\fR"
.ti -1c
.RI "const \fBACE_TCHAR\fR* \fBfilename\fR (void) const"
.br
.RI "\fIReturn the name of file that is mapped (if any).\fR"
.ti -1c
.RI "virtual int \fBclose\fR (void)"
.br
.RI "\fIClose down the shared memory segment.\fR"
.ti -1c
.RI "virtual int \fBremove\fR (void)"
.br
.RI "\fIRemove the shared memory segment and the underlying file.\fR"
.ti -1c
.RI "virtual void* \fBmalloc\fR (size_t size = 0)"
.br
.RI "\fICreate a new chuck of memory containing <size> bytes.\fR"
.ti -1c
.RI "virtual int \fBfree\fR (void *p)"
.br
.RI "\fIFree a chuck of memory allocated by .\fR"
.ti -1c
.RI "virtual int \fBget_segment_size\fR (void) const"
.br
.RI "\fIReturn the size of the shared memory segment.\fR"
.ti -1c
.RI "virtual ACE_HANDLE \fBget_id\fR (void) const"
.br
.RI "\fIReturn the ID of the shared memory segment (i.e., an ACE_HANDLE).\fR"
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.in -1c
.SS Public Attributes

.in +1c
.ti -1c
.RI "\fBACE_ALLOC_HOOK_DECLARE\fR"
.br
.RI "\fIDeclare the dynamic allocation hooks.\fR"
.in -1c
.SS Private Attributes

.in +1c
.ti -1c
.RI "\fBACE_Mem_Map\fR \fBshared_memory_\fR"
.br
.RI "\fIThis version is implemented with memory-mapped files.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Shared memory wrapper based on MMAP.
.PP
.PP
 This class provides a very simple-minded shared memory manager. For more a powerful memory allocator please see . 
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_Shared_Memory_MM::ACE_Shared_Memory_MM (void)
.PP
Default constructor.
.PP
.SS ACE_Shared_Memory_MM::ACE_Shared_Memory_MM (ACE_HANDLE handle, int length = -1, int prot = PROT_RDWR, int share = ACE_MAP_PRIVATE, char * addr = 0, off_t pos = 0)
.PP
Constructor.
.PP
.SS ACE_Shared_Memory_MM::ACE_Shared_Memory_MM (const \fBACE_TCHAR\fR * file_name, int len = -1, int flags = O_RDWR | O_CREAT, int mode = ACE_DEFAULT_FILE_PERMS, int prot = PROT_RDWR, int share = ACE_MAP_SHARED, char * addr = 0, off_t pos = 0)
.PP
Constructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_Shared_Memory_MM::close (void)\fC [virtual]\fR
.PP
Close down the shared memory segment.
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SS void ACE_Shared_Memory_MM::dump (void) const
.PP
Dump the state of an object.
.PP
.SS const \fBACE_TCHAR\fR * ACE_Shared_Memory_MM::filename (void) const
.PP
Return the name of file that is mapped (if any).
.PP
.SS int ACE_Shared_Memory_MM::free (void * p)\fC [virtual]\fR
.PP
Free a chuck of memory allocated by .
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SS ACE_HANDLE ACE_Shared_Memory_MM::get_id (void) const\fC [virtual]\fR
.PP
Return the ID of the shared memory segment (i.e., an ACE_HANDLE).
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SS int ACE_Shared_Memory_MM::get_segment_size (void) const\fC [virtual]\fR
.PP
Return the size of the shared memory segment.
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SS void * ACE_Shared_Memory_MM::malloc (size_t size = 0)\fC [virtual]\fR
.PP
Create a new chuck of memory containing <size> bytes.
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SS int ACE_Shared_Memory_MM::open (const \fBACE_TCHAR\fR * file_name, int len = -1, int flags = O_RDWR | O_CREAT, int mode = ACE_DEFAULT_FILE_PERMS, int prot = PROT_RDWR, int share = ACE_MAP_SHARED, char * addr = 0, off_t pos = 0)
.PP
Open method.
.PP
.SS int ACE_Shared_Memory_MM::open (ACE_HANDLE handle, int length = -1, int prot = PROT_RDWR, int share = ACE_MAP_PRIVATE, char * addr = 0, off_t pos = 0)
.PP
Open method.
.PP
.SS int ACE_Shared_Memory_MM::remove (void)\fC [virtual]\fR
.PP
Remove the shared memory segment and the underlying file.
.PP
Reimplemented from \fBACE_Shared_Memory\fR.
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS ACE_Shared_Memory_MM::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
.SS \fBACE_Mem_Map\fR ACE_Shared_Memory_MM::shared_memory_\fC [private]\fR
.PP
This version is implemented with memory-mapped files.
.PP


.SH AUTHOR
.PP 
Generated automatically by Doxygen for ACE from the source code.