File: ACE_Based_Pointer_Repository.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 (73 lines) | stat: -rw-r--r-- 2,254 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
.TH ACE_Based_Pointer_Repository 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Based_Pointer_Repository \- Maps pointers to the base address of the region to which each pointer belongs. 
.SH SYNOPSIS
.br
.PP
\fC#include <Based_Pointer_Repository.h>\fR
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_Based_Pointer_Repository\fR (void)"
.br
.ti -1c
.RI "\fB~ACE_Based_Pointer_Repository\fR (void)"
.br
.ti -1c
.RI "int \fBfind\fR (void *addr, void *&base_addr)"
.br
.ti -1c
.RI "int \fBbind\fR (void *addr, size_t size)"
.br
.RI "\fIBind a new entry to the repository or update the size of an existing entry. Returns 0 on success and -1 on failure.\fR"
.ti -1c
.RI "int \fBunbind\fR (void *addr)"
.br
.RI "\fIUnbind from the repository the <base_addr> that  is contained within.\fR"
.in -1c
.SS Private Attributes

.in +1c
.ti -1c
.RI "ACE_Based_Pointer_Repository_Rep* \fBrep_\fR"
.br
.RI "\fIUse the "Cheshire-Cat" technique to hide the implementation in order to avoid circular include dependencies.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Maps pointers to the base address of the region to which each pointer belongs.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_Based_Pointer_Repository::ACE_Based_Pointer_Repository (void)
.PP
.SS ACE_Based_Pointer_Repository::~ACE_Based_Pointer_Repository (void)
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_Based_Pointer_Repository::bind (void * addr, size_t size)
.PP
Bind a new entry to the repository or update the size of an existing entry. Returns 0 on success and -1 on failure.
.PP
.SS int ACE_Based_Pointer_Repository::find (void * addr, void *& base_addr)
.PP
Return the appropriate <base_addr> region that contains . Returns 1 on success and 0 if the  isn't contained in any <base_addr> region. 
.SS int ACE_Based_Pointer_Repository::unbind (void * addr)
.PP
Unbind from the repository the <base_addr> that  is contained within.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS ACE_Based_Pointer_Repository_Rep * ACE_Based_Pointer_Repository::rep_\fC [private]\fR
.PP
Use the "Cheshire-Cat" technique to hide the implementation in order to avoid circular include dependencies.
.PP


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