File: ACE_Read_Guard.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 (90 lines) | stat: -rw-r--r-- 2,661 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
.TH ACE_Read_Guard 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Read_Guard \- This class is similar to class , though it acquires/releases a read lock automatically (naturally, the  it is instantiated with must support the appropriate API). 
.SH SYNOPSIS
.br
.PP
\fC#include <Synch_T.h>\fR
.PP
Inherits \fBACE_Guard< ACE_LOCK >\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_Read_Guard\fR (ACE_LOCK& m)"
.br
.RI "\fIImplicitly and automatically acquire a read lock.\fR"
.ti -1c
.RI "\fBACE_Read_Guard\fR (ACE_LOCK &m, int block)"
.br
.RI "\fIImplicitly and automatically acquire (or try to acquire) a read lock.\fR"
.ti -1c
.RI "int \fBacquire_read\fR (void)"
.br
.RI "\fIExplicitly acquire the read lock.\fR"
.ti -1c
.RI "int \fBacquire\fR (void)"
.br
.RI "\fIExplicitly acquire the read lock.\fR"
.ti -1c
.RI "int \fBtryacquire_read\fR (void)"
.br
.RI "\fIConditionally acquire the read lock (i.e., won't block).\fR"
.ti -1c
.RI "int \fBtryacquire\fR (void)"
.br
.RI "\fIConditionally acquire the read lock (i.e., won't block).\fR"
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of an object.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 

.SS template<class ACE_LOCK>  template class ACE_Read_Guard
This class is similar to class , though it acquires/releases a read lock automatically (naturally, the  it is instantiated with must support the appropriate API).
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS template<classACE_LOCK> ACE_Read_Guard<ACE_LOCK>::ACE_Read_Guard<ACE_LOCK> (ACE_LOCK & m)
.PP
Implicitly and automatically acquire a read lock.
.PP
.SS template<classACE_LOCK> ACE_Read_Guard<ACE_LOCK>::ACE_Read_Guard<ACE_LOCK> (ACE_LOCK & m, int block)
.PP
Implicitly and automatically acquire (or try to acquire) a read lock.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS template<classACE_LOCK> int ACE_Read_Guard<ACE_LOCK>::acquire (void)
.PP
Explicitly acquire the read lock.
.PP
Reimplemented from \fBACE_Guard\fR.
.SS template<classACE_LOCK> int ACE_Read_Guard<ACE_LOCK>::acquire_read (void)
.PP
Explicitly acquire the read lock.
.PP
.SS template<classACE_LOCK> void ACE_Read_Guard<ACE_LOCK>::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_Guard\fR.
.SS template<classACE_LOCK> int ACE_Read_Guard<ACE_LOCK>::tryacquire (void)
.PP
Conditionally acquire the read lock (i.e., won't block).
.PP
Reimplemented from \fBACE_Guard\fR.
.SS template<classACE_LOCK> int ACE_Read_Guard<ACE_LOCK>::tryacquire_read (void)
.PP
Conditionally acquire the read lock (i.e., won't block).
.PP


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