diff options
author | William R. Otte <wotte@dre.vanderbilt.edu> | 2006-07-24 15:50:11 +0000 |
---|---|---|
committer | William R. Otte <wotte@dre.vanderbilt.edu> | 2006-07-24 15:50:11 +0000 |
commit | 8008dd09ccf88d4edef237a184a698cac42f2952 (patch) | |
tree | da50d054f9c761c3f6a5923f6979e93306c56d68 /ace/SOCK_IO.h | |
parent | 13d6e89af439164c0ade48e6f5c3e9b3f971e8c9 (diff) | |
download | ATCD-8008dd09ccf88d4edef237a184a698cac42f2952.tar.gz |
Repo restructuring
Diffstat (limited to 'ace/SOCK_IO.h')
-rw-r--r-- | ace/SOCK_IO.h | 163 |
1 files changed, 0 insertions, 163 deletions
diff --git a/ace/SOCK_IO.h b/ace/SOCK_IO.h deleted file mode 100644 index 746a414f6a2..00000000000 --- a/ace/SOCK_IO.h +++ /dev/null @@ -1,163 +0,0 @@ -// -*- C++ -*- - -//========================================================================== -/** - * @file SOCK_IO.h - * - * $Id$ - * - * @author Douglas C. Schmidt <schmidt@cs.wustl.edu> - */ -//========================================================================== - -#ifndef ACE_SOCK_IO_H -#define ACE_SOCK_IO_H - -#include /**/ "ace/pre.h" - -#include "ace/SOCK.h" - -#if !defined (ACE_LACKS_PRAGMA_ONCE) -# pragma once -#endif /* ACE_LACKS_PRAGMA_ONCE */ - -#include "ace/ACE.h" - -ACE_BEGIN_VERSIONED_NAMESPACE_DECL - -/** - * @class ACE_SOCK_IO - * - * @brief Defines the methods for the ACE socket wrapper I/O routines - * (e.g., send/recv). - * - * - * 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 until the relative time - * specified in *<timeout> elapses. - * Errors are reported by -1 and 0 return values. If the - * operation times out, -1 is returned with <errno == ETIME>. - * If it succeeds the number of bytes transferred is returned. - * 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 ACE_Export ACE_SOCK_IO : public ACE_SOCK -{ -public: - // = Initialization and termination methods. - - /// Constructor. - ACE_SOCK_IO (void); - - /// Destructor. - ~ACE_SOCK_IO (void); - - /// 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. - /** - * @note The value of @a n will be silently reduced to the maximum - * value an @c int can hold if needed. This is due to the underlying - * system calls on many OSes limiting the number of @c iovec structures - * that can be passed in one call. - */ - ssize_t recvv (iovec iov[], - size_t n, - const ACE_Time_Value *timeout = 0) const; - - /// @deprecated 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; - - /// Same as above. Deprecated. - ssize_t recv (iovec *io_vec, - const ACE_Time_Value *timeout = 0) const; - - /// Recv <n> varargs messages to the connected socket. - ssize_t recv (size_t n, - ...) 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. - /** - * @note The value of @a n will be silently reduced to the maximum - * value an @c int can hold if needed. This is due to the underlying - * system calls on many OSes limiting the number of @c iovec structures - * that can be passed in one call. - */ - ssize_t sendv (const iovec iov[], - size_t n, - const ACE_Time_Value *timeout = 0) const; - - /// Same as above. Deprecated. - ssize_t send (const iovec iov[], - size_t n, - const ACE_Time_Value *timeout = 0) const; - - /// Send <n> varargs messages to the connected socket. - ssize_t send (size_t n, - ...) const; - - /// Send <n> bytes via Win32 <WriteFile> using overlapped I/O. - ssize_t send (const void *buf, - size_t n, - ACE_OVERLAPPED *overlapped) const; - - /// 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_IO.inl" -#endif /* __ACE_INLINE__ */ - -#include /**/ "ace/post.h" - -#endif /* ACE_SOCK_IO_H */ |