AsyncFileWriter Class Reference

Write asynchronously to non-blocking file. More...

#include <asyncio.hh>

Inheritance diagram for AsyncFileWriter:

List of all members.

Classes
class	BufferInfo
Public Member Functions
	AsyncFileWriter (EventLoop &e, XorpFd fd, uint32_t coalesce=1, int priority=XorpTask::PRIORITY_DEFAULT)
void	add_buffer (const uint8_t *buffer, size_t buffer_bytes, const Callback &cb)
	Add an additional buffer for writing from.
void	add_buffer_sendto (const uint8_t *buffer, size_t buffer_bytes, const IPvX &dst_addr, uint16_t dst_port, const Callback &cb)
	Add an additional buffer for writing from by using sendto(2).
void	add_buffer_with_offset (const uint8_t *buffer, size_t buffer_bytes, size_t offset, const Callback &cb)
	Add an additional buffer for writing from.
void	add_data (const vector< uint8_t > &data, const Callback &cb)
	Add additional data for writing from.
void	add_data_sendto (const vector< uint8_t > &data, const IPvX &dst_addr, uint16_t dst_port, const Callback &cb)
	Add additional data for writing from by using sendto(2).
bool	start ()
	Start asynchronous operation.
void	stop ()
	Stop asynchronous operation.
size_t	buffers_remaining () const
void	flush_buffers ()
	Stop asynchronous operation and clear list of buffers.
virtual string	toString () const
Protected Member Functions
void	write (XorpFd, IoEventType)
void	complete_transfer (ssize_t done)
Protected Attributes
uint32_t	_coalesce
struct iovec *	_iov
ref_ptr< int >	_dtoken
list< BufferInfo * >	_buffers

---

Detailed Description

Write asynchronously to non-blocking file.

---

Constructor & Destructor Documentation

AsyncFileWriter::AsyncFileWriter	(	EventLoop &	e,
		XorpFd	fd,
		uint32_t	coalesce = 1,
		int	priority = XorpTask::PRIORITY_DEFAULT
	)

Parameters:

e	EventLoop that object should associate itself with.
fd	a file descriptor marked as non-blocking to write to.
coalesce	the number of buffers to coalesce for each write() system call.

---

Member Function Documentation

void AsyncFileWriter::add_buffer	(	const uint8_t *	buffer,
		size_t	buffer_bytes,
		const Callback &	cb
	)

Add an additional buffer for writing from.

Note that the buffer with the data is managed by the user.

Parameters:

buffer	pointer to buffer.
buffer_bytes	size of buffer in bytes.
cb	Callback object to invoke when I/O is performed.

void AsyncFileWriter::add_buffer_sendto	(	const uint8_t *	buffer,
		size_t	buffer_bytes,
		const IPvX &	dst_addr,
		uint16_t	dst_port,
		const Callback &	cb
	)

Add an additional buffer for writing from by using sendto(2).

Note that sendto()-buffers are never coalesced with other buffers.

Parameters:

buffer	pointer to buffer.
buffer_bytes	size of buffer in bytes.
dst_addr	the destination address to send the data to.
dst_port	the destination port (in host order) to send the data to.
cb	Callback object to invoke when I/O is performed.

void AsyncFileWriter::add_buffer_with_offset	(	const uint8_t *	buffer,
		size_t	buffer_bytes,
		size_t	offset,
		const Callback &	cb
	)

Add an additional buffer for writing from.

Parameters:

buffer	pointer to buffer.
buffer_bytes	size of buffer in bytes.
offset	the starting point to write from in the buffer.
cb	Callback object to invoke when I/O is performed.

void AsyncFileWriter::add_data	(	const vector< uint8_t > &	data,
		const Callback &	cb
	)

Add additional data for writing from.

Note that the data is stored to write is stored internally by AsyncFileWriter.

Parameters:

data	the data to write.
cb	Callback object to invoke when I/O is performed.

void AsyncFileWriter::add_data_sendto	(	const vector< uint8_t > &	data,
		const IPvX &	dst_addr,
		uint16_t	dst_port,
		const Callback &	cb
	)

Add additional data for writing from by using sendto(2).

Note that the data is stored to write is stored internally by AsyncFileWriter. Note that sendto()-buffers are never coalesced with other buffers.

Parameters:

data	the data to send.
dst_addr	the destination address to send the data to.
dst_port	the destination port (in host order) to send the data to.
cb	Callback object to invoke when I/O is performed.

size_t AsyncFileWriter::buffers_remaining

(

)

const [inline, virtual]

Returns:

the number of buffers available.

Implements AsyncFileOperator.

bool AsyncFileWriter::start

(

)

[virtual]

Start asynchronous operation.

Returns:

true on success, false if no buffers are available.

Implements AsyncFileOperator.

---

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

• /home/greearb/git/xorp.ct.github/xorp/libxorp/asyncio.hh
• /home/greearb/git/xorp.ct.github/xorp/libxorp/asyncio.cc