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
|
.TH ACE_Pipe 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Pipe \- Provides a bidirectional "pipe" abstraction that is portable to Windows NT, SVR4 UNIX, and BSD UNIX.
.SH SYNOPSIS
.br
.PP
\fC#include <Pipe.h>\fR
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Pipe\fR (void)"
.br
.RI "\fIDefault constructor (does nothing...).\fR"
.ti -1c
.RI "\fBACE_Pipe\fR (ACE_HANDLE handles[2])"
.br
.RI "\fIOpen the pipe and initialize the handles.\fR"
.ti -1c
.RI "\fBACE_Pipe\fR (ACE_HANDLE read, ACE_HANDLE write)"
.br
.RI "\fIInitialize the from the <read> and <write> handles.\fR"
.ti -1c
.RI "\fB~ACE_Pipe\fR (void)"
.br
.RI "\fIDefault dtor. It doesn't close the handles for you.\fR"
.ti -1c
.RI "int \fBopen\fR (ACE_HANDLE handles[2])"
.br
.RI "\fIOpen the pipe and initialize the handles.\fR"
.ti -1c
.RI "int \fBopen\fR (int buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ)"
.br
.RI "\fIOpen the pipe, setting the buffer size to the maximum.\fR"
.ti -1c
.RI "int \fBclose\fR (void)"
.br
.RI "\fIClose down the pipe HANDLEs;.\fR"
.ti -1c
.RI "ACE_HANDLE \fBread_handle\fR (void) const"
.br
.ti -1c
.RI "ACE_HANDLE \fBwrite_handle\fR (void) const"
.br
.ti -1c
.RI "void \fBdump\fR (void) const"
.br
.RI "\fIDump the state of the object.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "ACE_HANDLE \fBhandles_\fR [2]"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
Provides a bidirectional "pipe" abstraction that is portable to Windows NT, SVR4 UNIX, and BSD UNIX.
.PP
.PP
Uses "name" for lookup in the \fBACE\fR service repository. Obtains the object and returns it as the appropriate type.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Pipe::ACE_Pipe (void)
.PP
Default constructor (does nothing...).
.PP
.SS ACE_Pipe::ACE_Pipe (ACE_HANDLE handles[2])
.PP
Open the pipe and initialize the handles.
.PP
.SS ACE_Pipe::ACE_Pipe (ACE_HANDLE read, ACE_HANDLE write)
.PP
Initialize the from the <read> and <write> handles.
.PP
.SS ACE_Pipe::~ACE_Pipe (void)
.PP
Default dtor. It doesn't close the handles for you.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS int ACE_Pipe::close (void)
.PP
Close down the pipe HANDLEs;.
.PP
.SS void ACE_Pipe::dump (void) const
.PP
Dump the state of the object.
.PP
.SS int ACE_Pipe::open (int buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ)
.PP
Open the pipe, setting the buffer size to the maximum.
.PP
.SS int ACE_Pipe::open (ACE_HANDLE handles[2])
.PP
Open the pipe and initialize the handles.
.PP
.SS ACE_HANDLE ACE_Pipe::read_handle (void) const
.PP
This is the "read" side of the pipe. Note, however, that processes can also write to this handle as well since pipes are bi-directional.
.SS ACE_HANDLE ACE_Pipe::write_handle (void) const
.PP
This is the "write" side of the pipe. Note, however, that processes can also read to this handle as well since pipes are bi-directional.
.SH MEMBER DATA DOCUMENTATION
.PP
.SS ACE_HANDLE ACE_Pipe::handles_[2]\fC [private]\fR
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
