Read/Write operations on Files. More...

#include <FILE_IO.h>

Inheritance diagram for ACE_FILE_IO:

Collaboration diagram for ACE_FILE_IO:

Public Types
typedef ACE_FILE_Addr	PEER_ADDR
Public Member Functions
	ACE_FILE_IO (void)
	Default constructor.
ssize_t	send (const void *buf, size_t n) const
	send upto n bytes in buf.
ssize_t	recv (void *buf, size_t n) const
	Recv upto n bytes in buf.
ssize_t	send_n (const void *buf, size_t n) const
	Send n bytes, keep trying until n are sent.
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.
ssize_t	send (const iovec iov[], int n) const
	Send iovecs via <writev>.
ssize_t	recv (iovec iov[], int n) const
	Recv iovecs via <readv>.
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.
ssize_t	recv (void buf, size_t n, ACE_OVERLAPPED overlapped) const
	Recv n bytes via Win32 ReadFile using overlapped I/O.
ssize_t	sendv (const iovec iov[], int n) const
	Send an `iovec` of size n to the file.
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.
void	dump (void) const
	Dump the state of an object.
Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Friends
class	ACE_FILE_Connector

Detailed Description

Read/Write operations on Files.

Definition at line 44 of file FILE_IO.h.

Member Typedef Documentation

typedef ACE_FILE_Addr ACE_FILE_IO::PEER_ADDR

Definition at line 160 of file FILE_IO.h.

Constructor & Destructor Documentation

ACE_FILE_IO::ACE_FILE_IO ( void )

Default constructor.

Definition at line 34 of file FILE_IO.cpp.

{
  ACE_TRACE ("ACE_FILE_IO::ACE_FILE_IO");
}

Member Function Documentation

void ACE_FILE_IO::dump ( void ) const

Dump the state of an object.

Reimplemented from ACE_FILE.

Definition at line 21 of file FILE_IO.cpp.

{
#if defined (ACE_HAS_DUMP)
  ACE_TRACE ("ACE_FILE_IO::dump");

  ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
  this->addr_.dump ();
  ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
#endif /* ACE_HAS_DUMP */
}

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

Recv upto n bytes in buf.

Definition at line 82 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::recv");
  return ACE_OS::read (this->get_handle (), buf, n);
}

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!

Definition at line 84 of file FILE_IO.cpp.

{
  ACE_TRACE ("ACE_FILE_IO::recv");
  va_list argp;
  int total_tuples = ACE_Utils::truncate_cast<int> (n / 2);
  iovec *iovp = 0;
#if defined (ACE_HAS_ALLOCA)
  iovp = (iovec *) alloca (total_tuples * sizeof (iovec));
#else
  ACE_NEW_RETURN (iovp,
                  iovec[total_tuples],
                  -1);
#endif /* !defined (ACE_HAS_ALLOCA) */

  va_start (argp, n);

  for (int i = 0; i < total_tuples; i++)
    {
      iovp[i].iov_base = va_arg (argp, char *);
      iovp[i].iov_len  = va_arg (argp, int);
    }

  ssize_t const result = ACE_OS::readv (this->get_handle (),
                                        iovp,
                                        total_tuples);
#if !defined (ACE_HAS_ALLOCA)
  delete [] iovp;
#endif /* !defined (ACE_HAS_ALLOCA) */
  va_end (argp);
  return result;
}

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	(	iovec	iov[],
		int	n
	)			const `[inline]`

Recv iovecs via <readv>.

Definition at line 96 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::recv");
  return ACE_OS::readv (this->get_handle (), iov, n);
}

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

Recv n bytes, keep trying until n are received.

Definition at line 68 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::recv_n");
  return ACE::read_n (this->get_handle (), buf, n);
}

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.

Definition at line 122 of file FILE_IO.cpp.

{
  ACE_TRACE ("ACE_FILE_IO::recvv");

  io_vec->iov_base = 0;
  size_t const length =
    static_cast <size_t> (ACE_OS::filesize (this->get_handle ()));

  if (length > 0)
    {
      ACE_NEW_RETURN (io_vec->iov_base,
                      char[length],
                      -1);
      io_vec->iov_len = this->recv_n (io_vec->iov_base,
                                      length);
      return io_vec->iov_len;
    }
  else
    {
      return ACE_Utils::truncate_cast<ssize_t> (length);
    }
}

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

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

Definition at line 35 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::recvv_n");
  // @@ Carlos, can you please update this to call the
  // new ACE::recvv_n() method that you write?
  return ACE_OS::readv (this->get_handle (),
                        iov,
                        n);
}

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!

Definition at line 45 of file FILE_IO.cpp.

{
  ACE_TRACE ("ACE_FILE_IO::send");
  va_list argp;
  int total_tuples = ACE_Utils::truncate_cast<int> (n / 2);
  iovec *iovp = 0;
#if defined (ACE_HAS_ALLOCA)
  iovp = (iovec *) alloca (total_tuples * sizeof (iovec));
#else
  ACE_NEW_RETURN (iovp,
                  iovec[total_tuples],
                  -1);
#endif /* !defined (ACE_HAS_ALLOCA) */

  va_start (argp, n);

  for (int i = 0; i < total_tuples; i++)
    {
      iovp[i].iov_base = va_arg (argp, char *);
      iovp[i].iov_len  = va_arg (argp, int);
    }

  ssize_t result = ACE_OS::writev (this->get_handle (),
                                   iovp,
                                   total_tuples);
#if !defined (ACE_HAS_ALLOCA)
  delete [] iovp;
#endif /* !defined (ACE_HAS_ALLOCA) */
  va_end (argp);
  return result;
}

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

Send iovecs via <writev>.

Definition at line 89 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::send");
  return ACE_OS::writev (this->get_handle (), iov, n);
}

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

send upto n bytes in buf.

Definition at line 75 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::send");
  return ACE_OS::write (this->get_handle (), buf, n);
}

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 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.

Definition at line 21 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::send_n");
  ACE_UNUSED_ARG (timeout);
  return ACE::write_n (this->get_handle (),
                      message_block,
                      bytes_transferred);
}

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

Send n bytes, keep trying until n are sent.

Definition at line 58 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::send_n");
  return ACE::write_n (this->get_handle (), buf, n);
}

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

Send an iovec of size n to the file.

Definition at line 48 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::sendv");
  return ACE_OS::writev (this->get_handle (), iov, n);
}

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.

Definition at line 12 of file FILE_IO.inl.

{
  ACE_TRACE ("ACE_FILE_IO::sendv_n");
  return ACE::writev_n (this->get_handle (),
                        iov,
                        n);
}

Friends And Related Function Documentation

friend class ACE_FILE_Connector [friend]

Definition at line 47 of file FILE_IO.h.

Member Data Documentation

ACE_FILE_IO::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_FILE.

Definition at line 157 of file FILE_IO.h.

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

ACE_FILE_IO Class Reference

Public Types

Public Member Functions