L4virtio::Svr::Data_buffer Struct Reference

Abstract data buffer. More...

#include <virtio>

Inherited by L4virtio::Svr::Console::Device_port::Buffer.

Collaboration diagram for L4virtio::Svr::Data_buffer:

Public Member Functions
template<typename T >
	Data_buffer (T *p)
	Create buffer for object p.
template<typename T >
void	set (T *p)
	Set buffer for object p.
l4_uint32_t	copy_to (Data_buffer *dst, l4_uint32_t max=UINT_MAX)
	Copy contents from this buffer to the destination buffer.
l4_uint32_t	skip (l4_uint32_t bytes)
	Skip given number of bytes in this buffer.
bool	done () const
	Check if there are no more bytes left in the buffer.

Data Fields
char *	pos
	Current buffer position.
l4_uint32_t	left
	Bytes left in buffer.

Detailed Description

Abstract data buffer.

Definition at line 287 of file virtio.

Constructor & Destructor Documentation

Data_buffer()

template<typename T >

L4virtio::Svr::Data_buffer::Data_buffer ( T *  p )

inlineexplicit

Create buffer for object p.

Template Parameters

T	Type of object (implicit)

Parameters

p	Pointer to object.

The buffer shall point to the start of the object p and the size left is sizeof(T).

Definition at line 304 of file virtio.

Member Function Documentation

copy_to()

l4_uint32_t L4virtio::Svr::Data_buffer::copy_to ( Data_buffer *  dst, l4_uint32_t  max = UINT_MAX  )

inline

Copy contents from this buffer to the destination buffer.

Parameters

dst	Destination buffer.
max	(optional) Maximum number of bytes to copy.

Returns

the number of bytes copied.

This function copies at most max bytes from this to dst. If max is omitted, copies the maximum number of bytes available that fit dst.

Definition at line 335 of file virtio.

References left, and pos.

Referenced by L4virtio::Svr::Console::Device::port_write().

Here is the caller graph for this function:

done()

bool L4virtio::Svr::Data_buffer::done ( ) const

inline

Check if there are no more bytes left in the buffer.

Returns

true if there are no more bytes left in the buffer.

Definition at line 369 of file virtio.

References left.

set()

template<typename T >

void L4virtio::Svr::Data_buffer::set ( T *  p )

inline

Set buffer for object p.

Template Parameters

T	Type of object (implicit)

Parameters

p	Pointer to object.

The buffer shall point to the start of the object p and the size left is sizeof(T).

Definition at line 318 of file virtio.

References left, and pos.

skip()

l4_uint32_t L4virtio::Svr::Data_buffer::skip ( l4_uint32_t  bytes )

inline

Skip given number of bytes in this buffer.

Parameters

bytes

Number of bytes that shall be skipped.

Returns

The number of bytes skipped.

Try to skip the given number of bytes in this buffer, if there are less bytes left in the buffer that given then at most left bytes are skipped and the amount is returned.

Definition at line 356 of file virtio.

References left, and pos.

---

The documentation for this struct was generated from the following file:

• l4/l4virtio/server/virtio