ACE  6.3.3
Public Member Functions | Friends | List of all members
ACE_DEV_IO Class Reference

Read/Write operations on Devices. More...

#include <DEV_IO.h>

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

Public Member Functions

 ACE_DEV_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...
 
- Public Member Functions inherited from ACE_DEV
int close (void)
 Close down the DEVICE. More...
 
void dump (void) const
 Dump the state of an object. More...
 
int disable (int signum) const
 
- 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...
 

Friends

class ACE_DEV_Connector
 

I/O operations

Notes on common parameters:

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 until the relative time specified in *timeout elapses.

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.

typedef ACE_DEV_Addr PEER_ADDR
 Declare the dynamic allocation hooks. More...
 
 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks. More...
 
ACE_DEV_Addr addr_
 Address of device we are connected to. More...
 
ssize_t recv_n (void *buf, size_t n, const ACE_Time_Value *timeout=0, size_t *bytes_transferred=0) const
 Declare the dynamic allocation hooks. More...
 
ssize_t send (const iovec iov[], size_t n) const
 Send iovecs via <::writev>. More...
 
ssize_t recv (iovec iov[], size_t 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...
 
void dump (void) const
 Dump the state of an object. More...
 
int get_local_addr (ACE_DEV_Addr &) const
 Return the local endpoint address. More...
 
int get_remote_addr (ACE_DEV_Addr &) const
 

Additional Inherited Members

- Public Types inherited from ACE_IO_SAP
enum  { INVALID_HANDLE = -1 }
 
- Public Attributes inherited from ACE_DEV
 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...
 
- Protected Member Functions inherited from ACE_DEV
 ACE_DEV (void)
 Ensure that this class is an abstract base class. More...
 
- Protected Member Functions inherited from ACE_IO_SAP
 ACE_IO_SAP (void)
 Ensure that ACE_IO_SAP is an abstract base class. More...
 

Detailed Description

Read/Write operations on Devices.

Member Typedef Documentation

Declare the dynamic allocation hooks.

Constructor & Destructor Documentation

ACE_DEV_IO::ACE_DEV_IO ( void  )

Default constructor.

Member Function Documentation

void ACE_DEV_IO::dump ( void  ) const

Dump the state of an object.

int ACE_DEV_IO::get_local_addr ( ACE_DEV_Addr addr) const

Return the local endpoint address.

int ACE_DEV_IO::get_remote_addr ( ACE_DEV_Addr addr) const

Return the address of the remotely connected peer (if there is one).

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

Recv upto n bytes in buf.

ssize_t ACE_DEV_IO::recv ( iovec  iov[],
size_t  n 
) const
inline

Recv iovecs via <::readv>.

ssize_t ACE_DEV_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_DEV_IO::recv ( void *  buf,
size_t  n,
ACE_OVERLAPPED overlapped 
) const
inline

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

ssize_t ACE_DEV_IO::recv_n ( void *  buf,
size_t  n,
const ACE_Time_Value timeout = 0,
size_t *  bytes_transferred = 0 
) const
inline

Declare the dynamic allocation hooks.

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

send upto n bytes in buf.

ssize_t ACE_DEV_IO::send ( const iovec  iov[],
size_t  n 
) const
inline

Send iovecs via <::writev>.

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

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

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

Send n bytes, keep trying until n are sent.

Friends And Related Function Documentation

friend class ACE_DEV_Connector
friend

Member Data Documentation

ACE_DEV_IO::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

ACE_DEV_Addr ACE_DEV_IO::addr_
private

Address of device we are connected to.


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