File: ACE_FIFO.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 (128 lines) | stat: -rw-r--r-- 3,601 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
.TH ACE_FIFO 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_FIFO \- Abstract base class for UNIX FIFOs. 
.SH SYNOPSIS
.br
.PP
\fC#include <FIFO.h>\fR
.PP
Inherits \fBACE_IPC_SAP\fR.
.PP
Inherited by \fBACE_FIFO_Recv\fR, and \fBACE_FIFO_Send\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "int \fBopen\fR (const \fBACE_TCHAR\fR *rendezvous, int flags, int perms, LPSECURITY_ATTRIBUTES sa = 0)"
.br
.RI "\fIOpen up the named pipe on the <rendezvous> in accordance with the flags.\fR"
.ti -1c
.RI "int \fBclose\fR (void)"
.br
.RI "\fIClose down the ACE_FIFO without removing the rendezvous point.\fR"
.ti -1c
.RI "int \fBremove\fR (void)"
.br
.RI "\fIClose down the ACE_FIFO and remove the rendezvous point from the file system.\fR"
.ti -1c
.RI "int \fBget_local_addr\fR (const \fBACE_TCHAR\fR *&rendezvous) const"
.br
.RI "\fIReturn the local address of this endpoint.\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 Protected Methods

.in +1c
.ti -1c
.RI "\fBACE_FIFO\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.ti -1c
.RI "\fBACE_FIFO\fR (const \fBACE_TCHAR\fR *rendezvous, int flags, int perms, LPSECURITY_ATTRIBUTES sa = 0)"
.br
.RI "\fIOpen up the named pipe on the <rendezvous> in accordance with the flags.\fR"
.in -1c
.SS Private Attributes

.in +1c
.ti -1c
.RI "\fBACE_TCHAR\fR \fBrendezvous_\fR [MAXPATHLEN + 1]"
.br
.RI "\fIRendezvous point in the file system.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Abstract base class for UNIX FIFOs.
.PP
.PP
 UNIX FIFOs are also known Named Pipes, which are totally unrelated to Win32 Named Pipes. If you want to use a local IPC mechanism that will be portable to both UNIX and Win32, take a look at the  classes. 
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_FIFO::ACE_FIFO (void)\fC [protected]\fR
.PP
Default constructor.
.PP
.SS ACE_FIFO::ACE_FIFO (const \fBACE_TCHAR\fR * rendezvous, int flags, int perms, LPSECURITY_ATTRIBUTES sa = 0)\fC [protected]\fR
.PP
Open up the named pipe on the <rendezvous> in accordance with the flags.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_FIFO::close (void)
.PP
Close down the ACE_FIFO without removing the rendezvous point.
.PP
Reimplemented in \fBACE_FIFO_Recv\fR.
.SS void ACE_FIFO::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_IPC_SAP\fR.
.PP
Reimplemented in \fBACE_FIFO_Recv\fR, \fBACE_FIFO_Recv_Msg\fR, \fBACE_FIFO_Send\fR, and \fBACE_FIFO_Send_Msg\fR.
.SS int ACE_FIFO::get_local_addr (const \fBACE_TCHAR\fR *& rendezvous) const
.PP
Return the local address of this endpoint.
.PP
.SS int ACE_FIFO::open (const \fBACE_TCHAR\fR * rendezvous, int flags, int perms, LPSECURITY_ATTRIBUTES sa = 0)
.PP
Open up the named pipe on the <rendezvous> in accordance with the flags.
.PP
Reimplemented in \fBACE_FIFO_Send\fR, and \fBACE_FIFO_Send_Msg\fR.
.SS int ACE_FIFO::remove (void)
.PP
Close down the ACE_FIFO and remove the rendezvous point from the file system.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS ACE_FIFO::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented from \fBACE_IPC_SAP\fR.
.PP
Reimplemented in \fBACE_FIFO_Recv\fR, \fBACE_FIFO_Recv_Msg\fR, \fBACE_FIFO_Send\fR, and \fBACE_FIFO_Send_Msg\fR.
.SS \fBACE_TCHAR\fR ACE_FIFO::rendezvous_[MAXPATHLEN+1]\fC [private]\fR
.PP
Rendezvous point in the file system.
.PP


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