ACE  6.3.3
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
ACE_FILE_IO Class Reference

Read/Write operations on Files. More...

#include <FILE_IO.h>

Inheritance diagram for ACE_FILE_IO:
Inheritance graph
[legend]
Collaboration diagram for ACE_FILE_IO:
Collaboration graph
[legend]

Public Types

typedef ACE_FILE_Addr PEER_ADDR
 
- Public Types inherited from ACE_IO_SAP
enum  { INVALID_HANDLE = -1 }
 

Public Member Functions

 ACE_FILE_IO (void)
 Default constructor. More...
 
ssize_t send (const void *buf, size_t n) const
 send upto n bytes in buf. More...
 
ssize_t recv (void *buf, size_t n) const
 Recv upto n bytes in buf. More...
 
ssize_t send_n (const void *buf, size_t n) const
 Send n bytes, keep trying until n are sent. More...
 
ssize_t send_n (const ACE_Message_Block *message_block, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0)
 
ssize_t recv_n (void *buf, size_t n) const
 Recv n bytes, keep trying until n are received. More...
 
ssize_t send (const iovec iov[], int n) const
 Send iovecs via <::writev>. More...
 
ssize_t recv (iovec iov[], int n) const
 Recv iovecs via <::readv>. More...
 
ssize_t send (size_t n,...) const
 
ssize_t recv (size_t n,...) const
 
ssize_t send (const void *buf, size_t n, ACE_OVERLAPPED *overlapped) const
 Send n bytes via Win32 WriteFile using overlapped I/O. More...
 
ssize_t recv (void *buf, size_t n, ACE_OVERLAPPED *overlapped) const
 Recv n bytes via Win32 ReadFile using overlapped I/O. More...
 
ssize_t sendv (const iovec iov[], int n) const
 Send an iovec of size n to the file. More...
 
ssize_t recvv (iovec *io_vec)
 
ssize_t sendv_n (const iovec iov[], int n) const
 
ssize_t recvv_n (iovec iov[], int n) const
 Receive an <iovec> of size n to the file. More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_FILE
int close (void)
 
int remove (void)
 Close and remove the ACE_FILE from the file system. More...
 
int unlink (void)
 
int get_info (ACE_FILE_Info *finfo)
 Get information on this ACE_FILE. More...
 
int get_info (ACE_FILE_Info &finfo)
 Get information on this ACE_FILE. More...
 
int truncate (ACE_OFF_T length)
 Set filesize to length byte. More...
 
ACE_OFF_T seek (ACE_OFF_T offset, int whence=SEEK_CUR)
 
ACE_OFF_T tell (void)
 Return an offset for the file handle. More...
 
int disable (int signum) const
 
int get_local_addr (ACE_Addr &) const
 
int get_remote_addr (ACE_Addr &) const
 Return the same thing as get_local_addr(). More...
 
void dump (void) const
 Dump the state of an object. More...
 
- Public Member Functions inherited from ACE_IO_SAP
 ~ACE_IO_SAP (void)
 Default dtor. More...
 
int control (int cmd, void *) const
 Interface for ioctl. More...
 
int enable (int value) const
 
int disable (int value) const
 
ACE_HANDLE get_handle (void) const
 Get the underlying handle. More...
 
void set_handle (ACE_HANDLE handle)
 Set the underlying handle. More...
 
void dump (void) const
 Dump the state of an object. More...
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_FILE
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
- Public Attributes inherited from ACE_IO_SAP
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 

Friends

class ACE_FILE_Connector
 

Additional Inherited Members

- Protected Member Functions inherited from ACE_FILE
 ACE_FILE (void)
 
- Protected Member Functions inherited from ACE_IO_SAP
 ACE_IO_SAP (void)
 Ensure that ACE_IO_SAP is an abstract base class. More...
 
- Protected Attributes inherited from ACE_FILE
ACE_FILE_Addr addr_
 File we are "connected" with... More...
 

Detailed Description

Read/Write operations on Files.

Member Typedef Documentation

Constructor & Destructor Documentation

ACE_FILE_IO::ACE_FILE_IO ( void  )

Default constructor.

Member Function Documentation

void ACE_FILE_IO::dump ( void  ) const

Dump the state of an object.

ssize_t ACE_FILE_IO::recv ( void *  buf,
size_t  n 
) const
inline

Recv upto n bytes in buf.

ssize_t ACE_FILE_IO::recv ( iovec  iov[],
int  n 
) const
inline

Recv iovecs via <::readv>.

ssize_t ACE_FILE_IO::recv ( 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 couple of the number of tuple pairs!

ssize_t ACE_FILE_IO::recv ( void *  buf,
size_t  n,
ACE_OVERLAPPED overlapped 
) const

Recv n bytes via Win32 ReadFile using overlapped I/O.

ssize_t ACE_FILE_IO::recv_n ( void *  buf,
size_t  n 
) const
inline

Recv n bytes, keep trying until n are received.

ssize_t ACE_FILE_IO::recvv ( iovec *  io_vec)

Allows a client to read from a file without having to provide a buffer to read. This method determines how much data is in the file, 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 ACE_FILE_IO::recvv_n ( iovec  iov[],
int  n 
) const
inline

Receive an <iovec> of size n to the file.

ssize_t ACE_FILE_IO::send ( const void *  buf,
size_t  n 
) const
inline

send upto n bytes in buf.

ssize_t ACE_FILE_IO::send ( const iovec  iov[],
int  n 
) const
inline

Send iovecs via <::writev>.

ssize_t ACE_FILE_IO::send ( size_t  n,
  ... 
) 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 ACE_FILE_IO::send ( const void *  buf,
size_t  n,
ACE_OVERLAPPED overlapped 
) const

Send n bytes via Win32 WriteFile using overlapped I/O.

ssize_t ACE_FILE_IO::send_n ( const void *  buf,
size_t  n 
) const
inline

Send n bytes, keep trying until n are sent.

ssize_t ACE_FILE_IO::send_n ( const ACE_Message_Block message_block,
const ACE_Time_Value timeout = 0,
size_t *  bytes_transferred = 0 
)
inline

Send all the 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 ACE_FILE_IO::sendv ( const iovec  iov[],
int  n 
) const
inline

Send an iovec of size n to the file.

ssize_t ACE_FILE_IO::sendv_n ( const iovec  iov[],
int  n 
) const
inline

Send an <iovec> of size n to the file. Will block until all bytes are sent or an error occurs.

Friends And Related Function Documentation

friend class ACE_FILE_Connector
friend

Member Data Documentation

ACE_FILE_IO::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.


The documentation for this class was generated from the following files: