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_IPC_SAP 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_IPC_SAP \- Defines the member functions for the base class of the ACE_IPC_SAP abstraction.
.SH SYNOPSIS
.br
.PP
\fC#include <IPC_SAP.h>\fR
.PP
Inherited by \fBACE_FIFO\fR, \fBACE_SOCK\fR, \fBACE_SPIPE\fR, and \fBACE_TLI\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fB~ACE_IPC_SAP\fR (void)"
.br
.RI "\fIDefault dtor.\fR"
.ti -1c
.RI "int \fBcontrol\fR (int cmd, void *) const"
.br
.RI "\fIInterface for <ioctl>.\fR"
.ti -1c
.RI "int \fBenable\fR (int value) const"
.br
.ti -1c
.RI "int \fBdisable\fR (int value) const"
.br
.ti -1c
.RI "ACE_HANDLE \fBget_handle\fR (void) const"
.br
.RI "\fIGet the underlying handle.\fR"
.ti -1c
.RI "void \fBset_handle\fR (ACE_HANDLE handle)"
.br
.RI "\fISet the underlying handle.\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_IPC_SAP\fR (void)"
.br
.RI "\fIDefault constructor.\fR"
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "ACE_HANDLE \fBhandle_\fR"
.br
.RI "\fIUnderlying I/O handle.\fR"
.in -1c
.SS Static Private Attributes
.in +1c
.ti -1c
.RI "\fBpid_t\fR \fBpid_\fR"
.br
.RI "\fICache the process ID.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
Defines the member functions for the base class of the ACE_IPC_SAP abstraction.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_IPC_SAP::~ACE_IPC_SAP (void)
.PP
Default dtor.
.PP
.SS ACE_IPC_SAP::ACE_IPC_SAP (void)\fC [protected]\fR
.PP
Default constructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS int ACE_IPC_SAP::control (int cmd, void * val) const
.PP
Interface for <ioctl>.
.PP
Reimplemented in \fBACE_UPIPE_Stream\fR.
.SS int ACE_IPC_SAP::disable (int signum) const
.PP
Disable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), which is passed as the <value>.
.PP
Reimplemented in \fBACE_SPIPE\fR.
.SS void ACE_IPC_SAP::dump (void) const
.PP
Dump the state of an object.
.PP
Reimplemented in \fBACE_FIFO\fR, \fBACE_FIFO_Recv\fR, \fBACE_FIFO_Recv_Msg\fR, \fBACE_FIFO_Send\fR, \fBACE_FIFO_Send_Msg\fR, \fBACE_LSOCK_Acceptor\fR, \fBACE_LSOCK_CODgram\fR, \fBACE_LSOCK_Dgram\fR, \fBACE_LSOCK_Stream\fR, \fBACE_MEM_Acceptor\fR, \fBACE_MEM_IO\fR, \fBACE_MEM_Stream\fR, \fBACE_SOCK\fR, \fBACE_SOCK_Acceptor\fR, \fBACE_SOCK_CODgram\fR, \fBACE_SOCK_Dgram\fR, \fBACE_SOCK_Dgram_Bcast\fR, \fBACE_SOCK_Dgram_Mcast\fR, \fBACE_SOCK_IO\fR, \fBACE_SOCK_Stream\fR, \fBACE_SPIPE\fR, \fBACE_SPIPE_Acceptor\fR, \fBACE_SPIPE_Stream\fR, \fBACE_TLI\fR, \fBACE_TLI_Acceptor\fR, \fBACE_TLI_Stream\fR, \fBACE_UPIPE_Acceptor\fR, and \fBACE_UPIPE_Stream\fR.
.SS int ACE_IPC_SAP::enable (int value) const
.PP
Enable asynchronous I/O (ACE_SIGIO), urgent data (ACE_SIGURG), non-blocking I/O (ACE_NONBLOCK), or close-on-exec (ACE_CLOEXEC), which is passed as the <value>.
.SS ACE_HANDLE ACE_IPC_SAP::get_handle (void) const
.PP
Get the underlying handle.
.PP
Reimplemented in \fBACE_LSOCK_CODgram\fR, \fBACE_LSOCK_Dgram\fR, \fBACE_LSOCK_Stream\fR, and \fBACE_UPIPE_Stream\fR.
.SS void ACE_IPC_SAP::set_handle (ACE_HANDLE fd)
.PP
Set the underlying handle.
.PP
Reimplemented in \fBACE_LSOCK_CODgram\fR, \fBACE_LSOCK_Dgram\fR, and \fBACE_LSOCK_Stream\fR.
.SH MEMBER DATA DOCUMENTATION
.PP
.SS ACE_IPC_SAP::ACE_ALLOC_HOOK_DECLARE
.PP
Declare the dynamic allocation hooks.
.PP
Reimplemented in \fBACE_FIFO\fR, \fBACE_FIFO_Recv\fR, \fBACE_FIFO_Recv_Msg\fR, \fBACE_FIFO_Send\fR, \fBACE_FIFO_Send_Msg\fR, \fBACE_LSOCK_Acceptor\fR, \fBACE_LSOCK_CODgram\fR, \fBACE_LSOCK_Dgram\fR, \fBACE_LSOCK_Stream\fR, \fBACE_MEM_Acceptor\fR, \fBACE_MEM_IO\fR, \fBACE_MEM_Stream\fR, \fBACE_SOCK\fR, \fBACE_SOCK_Acceptor\fR, \fBACE_SOCK_CODgram\fR, \fBACE_SOCK_Dgram\fR, \fBACE_SOCK_Dgram_Bcast\fR, \fBACE_SOCK_Dgram_Mcast\fR, \fBACE_SOCK_IO\fR, \fBACE_SOCK_Stream\fR, \fBACE_SPIPE\fR, \fBACE_SPIPE_Acceptor\fR, \fBACE_SPIPE_Stream\fR, \fBACE_TLI\fR, \fBACE_TLI_Acceptor\fR, \fBACE_TLI_Stream\fR, \fBACE_UPIPE_Acceptor\fR, and \fBACE_UPIPE_Stream\fR.
.SS ACE_HANDLE ACE_IPC_SAP::handle_\fC [private]\fR
.PP
Underlying I/O handle.
.PP
.SS \fBpid_t\fR ACE_IPC_SAP::pid_\fC [static, private]\fR
.PP
Cache the process ID.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
