/usr/include/ace/HTBP/HTBP_Stream.h is in libace-htbp-dev 6.3.3+dfsg-1.2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 | // -*- C++ -*-
//=============================================================================
/**
* @file HTBP_Stream.h
*
* @author Phil Mesnier, Priyanka Gontla
*/
//=============================================================================
#ifndef ACE_HTBP_STREAM_H
#define ACE_HTBP_STREAM_H
#include /**/ "ace/pre.h"
#include "ace/SOCK_Stream.h"
#include "ace/Message_Block.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "HTBP_Export.h"
#include "HTBP_Addr.h"
#include "HTBP_Filter.h"
#include "HTBP_Notifier.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
namespace ACE
{
namespace HTBP
{
// Forward declarations.
class Session;
/**
* @class Stream
*
* @brief A stream facade for the HTTP Tunneling Bidirectional Protocol
*
* This adds provides the common interface for applications to do
* I/O that ultimately is wrapped in HTTP for tunneling through
* firewalls.
*
* This class is modelled after the ACE_SOCK_Stream class, and
* provides all of the I/O methods available in that class. Since
* this is a facade, it does not derive from ACE_SOCK_Stream. It
* also does not provide the same performance as ACE_SOCK_Stream,
* as some data may have to be stored by the HTBP classes prior to
* transmission.
*
* <buf> is the buffer to write from or receive into.
* <len> is the number of bytes to transfer.
* The <timeout> parameter in the following methods indicates how
* long to blocking trying to transfer data. If <timeout> == 0,
* then the call behaves as a normal send/recv call, i.e., for
* blocking sockets, the call will block until action is possible;
* for non-blocking sockets, EWOULDBLOCK will be returned if no
* action is immediately possible.
* If <timeout> != 0, the call will wait for data to arrive no longer
* than the relative time specified in *<timeout>.
* 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. <timeout> is used
* to make sure we keep making progress, i.e., the same timeout
* value is used for every I/O operation in the loop and the timeout
* is not counted down.
* The return values for the "*_n()" methods match the return values
* from the non "_n()" methods and are specified as follows:
* - On complete transfer, the number of bytes transferred is returned.
* - On timeout, -1 is returned, errno == ETIME.
* - On error, -1 is returned, errno is set to appropriate error.
* - On EOF, 0 is returned, errno is irrelevant.
*
* On partial transfers, i.e., if any data is transferred before
* timeout/error/EOF, <bytes_transferred> will contain the number of
* bytes transferred.
* Methods with <iovec> parameter are I/O vector variants of the I/O
* operations.
* Methods with the extra <flags> argument will always result in
* <send> getting called. Methods without the extra <flags> argument
* will result in <send> getting called on Win32 platforms, and
* <write> getting called on non-Win32 platforms.
*/
class HTBP_Export Stream
{
public:
// Initialization and termination methods.
/// Constructor.
Stream (Session *s = 0);
/// Destructor.
~Stream (void);
// = I/O functions.
/// The Stream is a sibling of the ACE_SOCK_IO class, rather
/// than a decendant. This is due to the requirement to wrap all
/// messages with an HTTP request or reply wrapper, and to send
/// application data in only one direction on one stream.
/// Recv an <n> byte buffer from the connected socket.
ssize_t recv (void *buf,
size_t n,
int flags,
const ACE_Time_Value *timeout = 0) const;
/// Recv an <n> byte buffer from the connected socket.
ssize_t recv (void *buf,
size_t n,
const ACE_Time_Value *timeout = 0) const;
/// Recv an <iovec> of size <n> from the connected socket.
ssize_t recvv (iovec iov[],
int n,
const ACE_Time_Value *timeout = 0) const;
/// Same as above. Deprecated.
ssize_t recv (iovec iov[],
size_t n,
const ACE_Time_Value *timeout = 0) const;
/**
* Allows a client to read from a socket without having to
* provide a buffer to read. This method determines how much
* data is in the socket, allocates a buffer of this size, reads
* in the data, and returns the number of bytes read. The
* caller is responsible for deleting the member in the
* <iov_base> field of <io_vec> using delete []
* io_vec->iov_base.
*/
ssize_t recvv (iovec *io_vec,
const ACE_Time_Value *timeout = 0) const;
/// Recv <n> bytes via Win32 <ReadFile> using overlapped I/O.
ssize_t recv (void *buf,
size_t n,
ACE_OVERLAPPED *overlapped) const;
/// Send an <n> byte buffer to the connected socket.
ssize_t send (const void *buf,
size_t n,
int flags,
const ACE_Time_Value *timeout = 0) const;
/// Send an <n> byte buffer to the connected socket.
ssize_t send (const void *buf,
size_t n,
const ACE_Time_Value *timeout = 0) const;
/// Send an <iovec> of size <n> to the connected socket.
ssize_t sendv (const iovec iov[],
int n,
const ACE_Time_Value *timeout = 0) const;
/// Send <n> bytes via Win32 <WriteFile> using overlapped I/O.
ssize_t send (const void *buf,
size_t n,
ACE_OVERLAPPED *overlapped) const;
/// Try to recv exactly <len> bytes into <buf> from the
/// connected socket.
ssize_t recv_n (void *buf,
size_t len,
int flags,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
/// Try to recv exactly <len> bytes into <buf> from the
/// connected socket.
ssize_t recv_n (void *buf,
size_t len,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
/// Receive an <iovec> of size <iovcnt> from the connected
/// socket.
ssize_t recvv_n (iovec iov[],
int iovcnt,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
/// Try to send exactly <len> bytes from <buf> to the connection
/// socket.
ssize_t send_n (const void *buf,
size_t len,
int flags,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
/// Try to send exactly <len> bytes from <buf> to the connected
/// socket.
ssize_t send_n (const void *buf,
size_t len,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
/// Send all the <message_block>s 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) const;
/// Send an <iovec> of size <iovcnt> to the connected socket.
ssize_t sendv_n (const iovec iov[],
int iovcnt,
const ACE_Time_Value *timeout = 0,
size_t *bytes_transferred = 0) const;
// = Selectively close endpoints. / Close down the reader.
int close_reader (void);
/// Close down the writer.
int close_writer (void);
/**
* Close down the socket (we need this to make things work correctly
* on Win32, which requires use to do a <close_writer> before doing
* the close to avoid losing data).
*/
int close (void);
// = Meta-type info
typedef Addr PEER_ADDR;
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
public:
///@notes Added the following methods to continue with
/// current compilation of HTIOP. Might not be needed in
/// future. - Priyanka
/// {@
void set_handle (ACE_HANDLE h);
ACE_HANDLE get_handle (void) const;
Session *session (void) const;
void session (Session *s);
/**
* 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>.
*/
int enable (int value) const;
/**
* 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>.
*/
int disable (int value) const;
/**
* Return the address of the remotely connected peer (if there is
* one), in the referenced <ACE_Addr>. Returns 0 if successful, else
* -1.
*/
int get_remote_addr (Addr &) const;
/**
* Return the address of the remotely connected peer (if there is
* one), in the referenced <ACE_Addr>. Returns 0 if successful, else
* -1.
*/
int get_local_addr (Addr &) const;
//@}
private:
/// The session_ is a reference to the persistent session this stream is
/// associated with. On the inside, sessions are created by the Connector,
/// which then create streams on demand.
Session *session_;
};
}
}
ACE_END_VERSIONED_NAMESPACE_DECL
#include /**/ "ace/post.h"
#endif /* ACE_HTBP_STREAM_H */
|