ProtocolPP::jbuffacc< Q, T > Class Template Reference

Public Member Functions
	jbuffacc (std::list< std::array< Q, T >> &buffers)
	jbuffacc (jbuffacc< Q, T > &rhs)
	jbuffacc (const jbuffacc< Q, T > &rhs)
virtual	~jbuffacc ()=default
	standard destructor
void	write (int idx, int len, Q *data)
void	read (int idx, int len, Q *out)
void	get (std::shared_ptr< std::list< std::array< Q, T >>> &list)
std::list< std::array< Q, T > >	get ()
int	size ()
	return total number of bytes
int	buflen ()
	return length of individual buffers
int	numbufs ()
	return number of buffers being managed

Constructor & Destructor Documentation

jbuffacc() [1/3]

template<typename Q , std::size_t T>

jbuffacc::jbuffacc ( std::list< std::array< Q, T >> &  buffers )

explicit

constructor

Parameters

buffers

- linked-list of buffers to use

jbuffacc() [2/3]

template<typename Q , std::size_t T>

jbuffacc::jbuffacc

(

jbuffacc< Q, T > &

rhs

)

copy constructor

Parameters

rhs	- object to copy

jbuffacc() [3/3]

template<typename Q , std::size_t T>

jbuffacc::jbuffacc

(

const jbuffacc< Q, T > &

rhs

)

const copy constructor

Parameters

rhs	- CONST object to copy

Member Function Documentation

get() [1/2]

template<typename Q , std::size_t T>

std::list< std::array< Q, T > > jbuffacc::get

Return the linked-list of buffers

Returns

- linked-list of buffers

get() [2/2]

template<typename Q , std::size_t T>

void jbuffacc::get

(

std::shared_ptr< std::list< std::array< Q, T >>> &

list

)

Return the linked-list of buffers

Parameters

list	- linked-list of buffers

read()

template<typename Q , std::size_t T>

void jbuffacc::read	(	int	idx,
		int	len,
		Q *	out
	)

read data from the buffers from index for length

Parameters

idx	- index to start reading at in number of elements
len	- length of the data to read in number of elements
out	- pointer to hold the data from the buffers

write()

template<typename Q , std::size_t T>

void jbuffacc::write	(	int	idx,
		int	len,
		Q *	data
	)

write data to the buffers at index with length

Parameters

idx	- index to start writing at in number of elements
len	- length of the data to write in number of elements
data	- byte data to write into the buffers

---

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

• include/jbuffacc.h