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
|
/* -*- C++ -*- */
//=============================================================================
/**
* @file SPIPE_Stream.h
*
* $Id$
*
* @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
*/
//=============================================================================
#ifndef ACE_SPIPE_STREAM_H
#define ACE_SPIPE_STREAM_H
#include "ace/pre.h"
#include "ace/SPIPE.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/SPIPE_Addr.h"
#include "ace/ACE.h"
/**
* @class ACE_SPIPE_Stream
*
* @brief Defines the methods in the <ACE_SPIPE_Stream> abstraction.
*
* <buf> is the buffer to write from or receive into.
* <len> is the number of bytes to transfer.
*
* The "_n()" I/O methods keep looping until all the data has been
* transferred. These methods also work for sockets in non-blocking
* mode i.e., they keep looping on EWOULDBLOCK.
*
* The return values for the "*_n()" methods match the return values
* from the non "_n()" methods and are specified as follows:
* - The number of bytes transferred is returned.
* - On error, -1 is returned, errno is set to appropriate error.
* - On EOF, 0 is returned, errno is irrelevant.
*
* Methods with <iovec> parameter are I/O vector variants of the I/O
* operations.
*
* The <send> and <revc> operations use "message" semantics rather
* than "bytestream" semantics.
*/
class ACE_Export ACE_SPIPE_Stream : public ACE_SPIPE
{
public:
friend class ACE_SPIPE_Acceptor;
friend class ACE_SPIPE_Connector;
// = Initialization method.
/// Default constructor.
ACE_SPIPE_Stream (void);
/// Obtain the address of whom we are connected with.
int get_remote_addr (ACE_SPIPE_Addr &remote_sap) const;
/// Send an open FD to another process.
int send_handle (ACE_HANDLE handle) const;
/// Recv an open FD from another process.
int recv_handle (ACE_HANDLE &handle) const;
/// Recv an open FD from another process.
int recv_handle (strrecvfd &recvfd) const;
/// Send <len> bytes, keep trying until <len> are sent.
ssize_t send_n (const void *buf, size_t len) const;
/// Recv <len> bytes, keep trying until <len> are received.
ssize_t recv_n (void *buf, size_t len) const;
/// Send bytes via STREAM pipes using "band" mode.
ssize_t send (const void *buf, size_t len) const;
/// Recv bytes via STREAM pipes using "band" mode.
ssize_t recv (void *buf, size_t len) const;
/// Send <cntl> and <data> via STREAM pipes.
ssize_t send (const ACE_Str_Buf *cntl,
const ACE_Str_Buf *data,
int flags = 0) const;
/// Recv <cntl> and <data> via STREAM pipes.
ssize_t recv (ACE_Str_Buf *cntl,
ACE_Str_Buf *data,
int *flags) const;
/// Send bytes via STREAM pipes using "band" mode.
ssize_t send (const ACE_Str_Buf *cntl,
const ACE_Str_Buf *data,
int band,
int flags) const;
/// Recv bytes via STREAM pipes using "band" mode.
ssize_t recv (ACE_Str_Buf *cntl,
ACE_Str_Buf *data,
int *band,
int *flags) const;
/// Send iovecs via the OS "gather-write" operation.
ssize_t send (const iovec iov[], int len) const;
/// Recv iovecs via the OS "scatter-read" operation.
ssize_t recv (iovec iov[], int len) const;
/**
* 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 len, ...) 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 couple of the
* number of tuple pairs!
*/
ssize_t recv (size_t len, ...) const;
/// Send <len> bytes via Win32 <WriteFile> using overlapped I/O.
ssize_t send (const void *buf, size_t len, ACE_OVERLAPPED *overlapped) const;
/// Recv <len> bytes via Win32 <ReadFile> using overlapped I/O.
ssize_t recv (void *buf, size_t len, ACE_OVERLAPPED *overlapped) const;
/// Send an <iovec> of size <len> to the stream.
ssize_t sendv (const iovec iov[],
int len) const;
/// Send an <iovec> of size <len> to the stream. Will block until all
/// bytes are sent or an error occurs.
ssize_t sendv_n (const iovec iov[],
int len) const;
/// Receive an <iovec> of size <len> to the stream.
ssize_t recvv_n (iovec iov[],
int len) const;
// = Meta-type info
typedef ACE_SPIPE_Addr PEER_ADDR;
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
private:
ACE_SPIPE_Addr remote_addr_;
};
#if !defined (ACE_LACKS_INLINE_FUNCTIONS)
#include "ace/SPIPE_Stream.i"
#endif
#include "ace/post.h"
#endif /* ACE_SPIPE_STREAM_H */
|
