InterfacePP::ringin Class Reference

Public Member Functions
	ringin (uintptr_t address, uint32_t size, std::string stream, uint32_t protect=0, uintptr_t outaddr=0, uint32_t outlen=0)
virtual	~ringin ()=default
	standard deconstructor
uintptr_t	get_addr ()
uint32_t	get_size ()
uint32_t	get_protect ()
std::string	get_stream ()
uintptr_t	get_outaddr ()
uint32_t	get_outlen ()
void	set_addr (uintptr_t address)
void	set_size (uint32_t size)
void	set_protect (uint32_t protect)
void	set_stream (std::string &stream)
void	set_outaddr (uintptr_t outaddr)
void	set_outlen (uint32_t outlen)

Constructor & Destructor Documentation

ringin()

InterfacePP::ringin::ringin ( uintptr_t  address, uint32_t  size, std::string  stream, uint32_t  protect = 0, uintptr_t  outaddr = 0, uint32_t  outlen = 0  )

inline

Constructor for intput ring object

Parameters

address	- address of input
size	- size of input
stream	- name of the stream (flow)
protect	- protect (ENCAP) the data
outaddr	- address to write output
outlen	- length of the output memory

Sits in the input ring as

---

| address (8-byte input address) |

| size (4-byte value) |

| name (12-byte string) |

| protect (4-byte value 1 or 0) |

| outaddr (8-byte output address)|

| outlen (4-byte output length) |

Member Function Documentation

get_addr()

uintptr_t InterfacePP::ringin::get_addr ( )

inline

return address

Returns

- address

get_outaddr()

uintptr_t InterfacePP::ringin::get_outaddr ( )

inline

return the address of the output

Returns

- address of the output

get_outlen()

uint32_t InterfacePP::ringin::get_outlen ( )

inline

return the address of the output

Returns

- address of the output

get_protect()

uint32_t InterfacePP::ringin::get_protect ( )

inline

return protection status

Returns

- protection status

get_size()

uint32_t InterfacePP::ringin::get_size ( )

inline

return size

Returns

- size

get_stream()

std::string InterfacePP::ringin::get_stream ( )

inline

return name of the stream associated with this packet

Returns

- name of the stream

set_addr()

void InterfacePP::ringin::set_addr ( uintptr_t  address )

inline

set the address

Parameters

address

- address of the input

set_outaddr()

void InterfacePP::ringin::set_outaddr ( uintptr_t  outaddr )

inline

set the size of the input

Parameters

outaddr

- address to write output to

set_outlen()

void InterfacePP::ringin::set_outlen ( uint32_t  outlen )

inline

set the size of the output

Parameters

outlen

- length of the output memory

set_protect()

void InterfacePP::ringin::set_protect ( uint32_t  protect )

inline

set the size of the input

Parameters

protect

- protect (ENCAP) the data

set_size()

void InterfacePP::ringin::set_size ( uint32_t  size )

inline

set the size of the input

Parameters

size	- size of the input

set_stream()

void InterfacePP::ringin::set_stream ( std::string &  stream )

inline

set the name of the stream

Parameters

stream

- name of the stream

---

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

• jtestbench/include/ringobj.h