/usr/include/ace/SOCK_Stream.h is in libace-dev 6.2.8+dfsg-1.
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 | // -*- C++ -*-
//=============================================================================
/**
* @file SOCK_Stream.h
*
* $Id: SOCK_Stream.h 92956 2010-12-29 16:12:31Z shuston $
*
* @author Douglas C. Schmidt <schmidt@cs.wustl.edu>
*/
//=============================================================================
#ifndef ACE_SOCK_STREAM_H
#define ACE_SOCK_STREAM_H
#include /**/ "ace/pre.h"
#include "ace/SOCK_IO.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/INET_Addr.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
// Forward declarations.
class ACE_Message_Block;
/**
* @class ACE_SOCK_Stream
*
* @brief Defines the methods in the ACE_SOCK_Stream abstraction.
*
* This adds additional wrapper methods atop the ACE_SOCK_IO
* class.
*
* @sa ACE_SOCK_IO
*/
class ACE_Export ACE_SOCK_Stream : public ACE_SOCK_IO
{
public:
// Initialization and termination methods.
/// Constructor.
ACE_SOCK_Stream (void);
/// Constructor (sets the underlying ACE_HANDLE with @a h).
ACE_SOCK_Stream (ACE_HANDLE h);
/// Destructor.
~ACE_SOCK_Stream (void);
/** @name Counted send/receive methods
*
* The counted send/receive methods attempt to transfer a specified number
* of bytes even if they must block and retry the operation in order to
* transfer the entire amount. The time spent blocking for the entire
* transfer can be limited by a specified ACE_Time_Value object which is
* a relative time (i.e., a fixed amount of time, not an absolute time
* of day). These methods return the count of transferred bytes, or -1
* if an error occurs or the operation times out before the entire requested
* amount of data has been transferred. In error or timeout situations it's
* possible that some data was transferred before the error
* or timeout. The @c bytes_transferred parameter is used to obtain the
* count of bytes transferred before the error or timeout occurred. If the
* total specified number of bytes is transferred without error, the
* method return value should equal the value of @c bytes_transferred.
*
* @param buf The buffer to write from or receive into.
* @param iov An I/O vector containing a specified number of
* count/pointer pairs directing the data to be transferred.
* @param iovcnt The number of I/O vectors to be used from @a iov.
* @param len The number of bytes to transfer.
* @param flags Flags that will be passed through to the @c recv()
* system call.
* @param timeout Indicates how long to blocking trying to transfer data.
* If no timeout is supplied (timeout == 0) the method will
* wait indefinitely or until an error occurs for the
* specified number of bytes to be transferred.
* To avoid any waiting, specify a timeout value with
* 0 seconds. Note that the timeout period restarts on
* each retried operation issued; therefore, an operation
* that requires multiples retries may take longer than the
* specified timeout to complete.
* @param bytes_transferred If non-0, points to a location which receives
* the total number of bytes transferred before the method
* returns, even if it's less than the number requested.
*
* @retval len, the complete number of bytes transferred.
* @retval 0 EOF, i.e., the peer closed the connection.
* @retval -1 an error occurred before the entire amount was
* transferred. Check @c errno for more information.
* If the @a timeout period is reached, errno is ETIME.
*
* On partial transfers, i.e., if any data is transferred before
* timeout/error/EOF, *@a bytes_transferred will contain the number of
* bytes transferred.
*/
//@{
/// Try to recv exactly @a len bytes into @a 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 @a len bytes into @a 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 @c iovec of size @a 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 @a len bytes from @a 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 @a len bytes from @a 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 blocks chained through their @c next and
/// @c 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 @c iovec of size @a 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;
//@}
// = Send/receive ``urgent'' data (see TCP specs...).
ssize_t send_urg (const void *ptr,
size_t len = sizeof (char),
const ACE_Time_Value *timeout = 0) const;
ssize_t recv_urg (void *ptr,
size_t len = sizeof (char),
const ACE_Time_Value *timeout = 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 ACE_INET_Addr PEER_ADDR;
/// Dump the state of an object.
void dump (void) const;
/// Declare the dynamic allocation hooks.
ACE_ALLOC_HOOK_DECLARE;
};
ACE_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "ace/SOCK_Stream.inl"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* ACE_SOCK_STREAM_H */
|