File: ACE_SPIPE_Acceptor.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 (138 lines) | stat: -rw-r--r-- 3,954 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
129
130
131
132
133
134
135
136
137
138
.TH ACE_SPIPE_Acceptor 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_SPIPE_Acceptor \- Defines the format and interface for the listener side of the \fBACE_SPIPE_Stream\fR. 
.SH SYNOPSIS
.br
.PP
\fC#include <SPIPE_Acceptor.h>\fR
.PP
Inherits \fBACE_SPIPE\fR.
.PP
Inherited by \fBACE_UPIPE_Acceptor\fR.
.PP
.SS Public Types

.in +1c
.ti -1c
.RI "typedef \fBACE_SPIPE_Addr\fR \fBPEER_ADDR\fR"
.br
.ti -1c
.RI "typedef \fBACE_SPIPE_Stream\fR \fBPEER_STREAM\fR"
.br
.in -1c
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_SPIPE_Acceptor\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.ti -1c
.RI "\fBACE_SPIPE_Acceptor\fR (const \fBACE_SPIPE_Addr\fR &local_sap, int reuse_addr = 1, int perms = ACE_DEFAULT_FILE_PERMS)"
.br
.RI "\fIInitiate a passive-mode \fBSTREAM\fR pipe listener.\fR"
.ti -1c
.RI "int \fBopen\fR (const \fBACE_SPIPE_Addr\fR &local_sap, int reuse_addr = 1, int perms = ACE_DEFAULT_FILE_PERMS)"
.br
.RI "\fIInitiate a passive-mode \fBSTREAM\fR pipe listener.\fR"
.ti -1c
.RI "int \fBclose\fR (void)"
.br
.RI "\fIClose down the passive-mode \fBSTREAM\fR pipe listener.\fR"
.ti -1c
.RI "int \fBremove\fR (void)"
.br
.RI "\fIRemove the underlying mounted pipe from the file system.\fR"
.ti -1c
.RI "int \fBaccept\fR (\fBACE_SPIPE_Stream\fR &ipc_sap_spipe, \fBACE_SPIPE_Addr\fR *remote_addr = 0, \fBACE_Time_Value\fR *timeout = 0, int restart = 1, int reset_new_handle = 0)"
.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 Private Methods

.in +1c
.ti -1c
.RI "int \fBcreate_new_instance\fR (int perms = 0)"
.br
.RI "\fICreate a new instance of an SPIPE.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
Defines the format and interface for the listener side of the \fBACE_SPIPE_Stream\fR.
.PP
.SH MEMBER TYPEDEF DOCUMENTATION
.PP 
.SS typedef \fBACE_SPIPE_Addr\fR ACE_SPIPE_Acceptor::PEER_ADDR
.PP
.SS typedef \fBACE_SPIPE_Stream\fR ACE_SPIPE_Acceptor::PEER_STREAM
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_SPIPE_Acceptor::ACE_SPIPE_Acceptor (void)
.PP
Default constructor.
.PP
.SS ACE_SPIPE_Acceptor::ACE_SPIPE_Acceptor (const \fBACE_SPIPE_Addr\fR & local_sap, int reuse_addr = 1, int perms = ACE_DEFAULT_FILE_PERMS)
.PP
Initiate a passive-mode \fBSTREAM\fR pipe listener.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_SPIPE_Acceptor::accept (\fBACE_SPIPE_Stream\fR & ipc_sap_spipe, \fBACE_SPIPE_Addr\fR * remote_addr = 0, \fBACE_Time_Value\fR * timeout = 0, int restart = 1, int reset_new_handle = 0)
.PP
Accept a new data transfer connection. A <timeout> of 0 means block forever, a <timeout> of {0, 0} means poll. <restart> == 1 means "restart if interrupted." 
.SS int ACE_SPIPE_Acceptor::close (void)
.PP
Close down the passive-mode \fBSTREAM\fR pipe listener.
.PP
Reimplemented from \fBACE_SPIPE\fR.
.PP
Reimplemented in \fBACE_UPIPE_Acceptor\fR.
.SS int ACE_SPIPE_Acceptor::create_new_instance (int perms = 0)\fC [private]\fR
.PP
Create a new instance of an SPIPE.
.PP
.SS void ACE_SPIPE_Acceptor::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented from \fBACE_SPIPE\fR.
.PP
Reimplemented in \fBACE_UPIPE_Acceptor\fR.
.SS int ACE_SPIPE_Acceptor::open (const \fBACE_SPIPE_Addr\fR & local_sap, int reuse_addr = 1, int perms = ACE_DEFAULT_FILE_PERMS)
.PP
Initiate a passive-mode \fBSTREAM\fR pipe listener.
.PP
.SS int ACE_SPIPE_Acceptor::remove (void)
.PP
Remove the underlying mounted pipe from the file system.
.PP
Reimplemented from \fBACE_SPIPE\fR.
.PP
Reimplemented in \fBACE_UPIPE_Acceptor\fR.
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS ACE_SPIPE_Acceptor::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented from \fBACE_SPIPE\fR.
.PP
Reimplemented in \fBACE_UPIPE_Acceptor\fR.

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