File: ACE_SPIPE.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 (117 lines) | stat: -rw-r--r-- 3,037 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
.TH ACE_SPIPE 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_SPIPE \- Defines the member functions for the base class of the ACE_SPIPE abstraction. 
.SH SYNOPSIS
.br
.PP
\fC#include <SPIPE.h>\fR
.PP
Inherits \fBACE_IPC_SAP\fR.
.PP
Inherited by \fBACE_SPIPE_Acceptor\fR, \fBACE_SPIPE_Stream\fR, and \fBACE_UPIPE_Stream\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "int \fBclose\fR (void)"
.br
.RI "\fIClose down the \fBSTREAM\fR pipe without removing the rendezvous point.\fR"
.ti -1c
.RI "int \fBremove\fR (void)"
.br
.RI "\fIClose down the \fBSTREAM\fR pipe and remove the rendezvous point from the file system.\fR"
.ti -1c
.RI "int \fBget_local_addr\fR (\fBACE_SPIPE_Addr\fR &) const"
.br
.RI "\fIReturn the local address of this endpoint.\fR"
.ti -1c
.RI "int \fBdisable\fR (int signum) const"
.br
.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_SPIPE\fR (void)"
.br
.RI "\fIEnsure that this class is an abstract base class.\fR"
.in -1c
.SS Protected Attributes

.in +1c
.ti -1c
.RI "\fBACE_SPIPE_Addr\fR \fBlocal_addr_\fR"
.br
.RI "\fIOur local address.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Defines the member functions for the base class of the ACE_SPIPE abstraction.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_SPIPE::ACE_SPIPE (void)\fC [protected]\fR
.PP
Ensure that this class is an abstract base class.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_SPIPE::close (void)
.PP
Close down the \fBSTREAM\fR pipe without removing the rendezvous point.
.PP
Reimplemented in \fBACE_SPIPE_Acceptor\fR, \fBACE_UPIPE_Acceptor\fR, and \fBACE_UPIPE_Stream\fR.
.SS int ACE_SPIPE::disable (int signum) const
.PP
Disable signal <signum> This is here to prevent Win32 from disabling SPIPE using socket calls 
.PP
Reimplemented from \fBACE_IPC_SAP\fR.
.SS void ACE_SPIPE::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_IPC_SAP\fR.
.PP
Reimplemented in \fBACE_SPIPE_Acceptor\fR, \fBACE_SPIPE_Stream\fR, \fBACE_UPIPE_Acceptor\fR, and \fBACE_UPIPE_Stream\fR.
.SS int ACE_SPIPE::get_local_addr (\fBACE_SPIPE_Addr\fR &) const
.PP
Return the local address of this endpoint.
.PP
.SS int ACE_SPIPE::remove (void)
.PP
Close down the \fBSTREAM\fR pipe and remove the rendezvous point from the file system.
.PP
Reimplemented in \fBACE_SPIPE_Acceptor\fR, and \fBACE_UPIPE_Acceptor\fR.
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS ACE_SPIPE::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented from \fBACE_IPC_SAP\fR.
.PP
Reimplemented in \fBACE_SPIPE_Acceptor\fR, \fBACE_SPIPE_Stream\fR, \fBACE_UPIPE_Acceptor\fR, and \fBACE_UPIPE_Stream\fR.
.SS \fBACE_SPIPE_Addr\fR ACE_SPIPE::local_addr_\fC [protected]\fR
.PP
Our local address.
.PP


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