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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
// -*- C++ -*-
//==========================================================================
/**
* @file Pipe.h
*
* @author Douglas C. Schmidt <d.schmidt@vanderbilt.edu>
*/
//==========================================================================
#ifndef ACE_PIPE_H
#define ACE_PIPE_H
#include /**/ "ace/pre.h"
#include /**/ "ace/ACE_export.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Default_Constants.h"
#include "ace/OS_NS_sys_uio.h"
#include "ace/OS_NS_unistd.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
// Forward decl.
class ACE_Message_Block;
class ACE_Time_Value;
/**
* @class ACE_Pipe
*
* @brief Provides a portable bidirectional "pipe" abstraction.
*
* This class is designed to work with select()-based demuxers, such
* as the ACE_Select_Reactor, which is why it uses sockets on Windows
* rather than Win32 pipes (which aren't select()'able).
*/
class ACE_Export ACE_Pipe
{
public:
/// Default constructor (does nothing...).
ACE_Pipe (void);
/// Open the pipe and initialize the handles.
ACE_Pipe (ACE_HANDLE handles[2]);
/// Initialize the ACE_Pipe from the @a read and @a write handles.
ACE_Pipe (ACE_HANDLE read, ACE_HANDLE write);
/// Default dtor. It doesn't close the handles for you.
~ACE_Pipe (void);
/// Open the pipe and initialize the handles.
int open (ACE_HANDLE handles[2]);
/// Open the pipe, setting the buffer size to the maximum.
int open (int buffer_size = ACE_DEFAULT_MAX_SOCKET_BUFSIZ);
/// Close down the pipe HANDLEs;
int close (void);
int close_read (void);
int close_write (void);
// = Accessors.
/**
* 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.
*/
ACE_HANDLE read_handle () const;
/**
* 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.
*/
ACE_HANDLE write_handle () const;
/// Dump the state of the object.
void dump () const;
/// send upto @a n bytes in @a buf.
ssize_t send (const void *buf, size_t n) const;
/// Recv upto @a n bytes in @a buf.
ssize_t recv (void *buf, size_t n) const;
/// Send n bytes, keep trying until n are sent.
ssize_t send_n (const void *buf, size_t n) const;
/// Send all the @a message_blocks chained through their <next> and
/// <cont> pointers. This call uses the underlying OS gather-write
/// operation to reduce the domain-crossing penalty.
ssize_t send_n (const ACE_Message_Block *message_block,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0);
/// Recv n bytes, keep trying until n are received.
ssize_t recv_n (void *buf, size_t n) const;
/// Send iovecs via <::writev>.
ssize_t send (const iovec iov[], int n) const;
/// Recv iovecs via <::readv>.
ssize_t recv (iovec iov[], int n) const;
#if !defined (ACE_LACKS_VA_FUNCTIONS)
/**
* Send N char *ptrs and int lengths. Note that the char *'s
* precede the ints (basically, an varargs version of writev). The
* count N is the *total* number of trailing arguments, *not* a
* couple of the number of tuple pairs!
*/
ssize_t send (size_t n, ...) const;
/**
* This is an interface to ::readv, that doesn't use the struct
* iovec explicitly. The ... can be passed as an arbitrary number
* of (char *ptr, int len) tuples. However, the count N is the
* *total* number of trailing arguments, *not* a count of the
* number of tuple pairs!
*/
ssize_t recv (size_t n, ...) const;
#endif /* !ACE_LACKS_VA_FUNCTIONS */
/// Send @a n bytes via Win32 WriteFile using overlapped I/O.
ssize_t send (const void *buf,
size_t n,
ACE_OVERLAPPED *overlapped) const;
/// Recv @a n bytes via Win32 ReadFile using overlapped I/O.
ssize_t recv (void *buf,
size_t n,
ACE_OVERLAPPED *overlapped) const;
/// Send an <iovec> of size @a n to the file.
ssize_t sendv (const iovec iov[],
int n) const;
/// Send an @c iovec of size @a n to the file. Will block until all
/// bytes are sent or an error occurs.
ssize_t sendv_n (const iovec iov[],
int n) const;
/// Receive an @c iovec of size @a n to the file.
ssize_t recvv_n (iovec iov[],
int n) const;
private:
ACE_HANDLE handles_[2];
int close_handle (int which);
};
ACE_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "ace/Pipe.inl"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* ACE_PIPE_H */
|
