cornelluniversity::vetserial::control_request Class Reference

Implements a control (or header-only) command. Provides the interface required for minimal functionality required to manipulate and generate a header. More...

#include <vetprot.h>

Inheritance diagram for cornelluniversity::vetserial::control_request:

List of all members.

Public Member Functions
	control_request (void)
	control_request (const uint8_ *in_pkt, uint32_ nbytes)
virtual	~control_request (void)
void	ack_request (void)
	very thin wrapper of a common use-case; configures the header for an ACK request
void	ack_response (void)
	very thin wrapper of a common use-case; configures the header to respond to an ACK request
void	nak_request (void)
	very thin wrapper of a common use-case; configures the header for a NAK request
void	nak_response (void)
	very thin wrapper of a common use-case; configures the header to respond to a NAK request
void	set_responsive (void)
	very thin wrapper of a common use-case; configures the header to request the target to ACK or NAK
virtual void	serialize (void)
	Simply generates the header, utilizing the currently values of the private members, and leaves it in the internal buffers waiting for you to grab it.
virtual void	deserialize (void)
	parses apart a received packet into the appropriate private members for use via the typical accessor process. Exceptions: cornelluniversity::vetsim_badchksum  if the crc validation fails cornelluniversity::vetsim_exception  if the header size is deemed irregular cornelluniversity::vetsim_exception  if packet_ buffer is empty (null pointer)

---

Detailed Description

Implements a control (or header-only) command. Provides the interface required for minimal functionality required to manipulate and generate a header.

base_command

---

Constructor & Destructor Documentation

cornelluniversity::vetserial::control_request::control_request

(

void

)

[inline]

cornelluniversity::vetserial::control_request::control_request	(	const uint8_ *	in_pkt,
		uint32_	nbytes
	)			[inline]

virtual cornelluniversity::vetserial::control_request::~control_request

(

void

)

[inline, virtual]

---

Member Function Documentation

void cornelluniversity::vetserial::control_request::ack_request

(

void

)

[inline]

very thin wrapper of a common use-case; configures the header for an ACK request

void cornelluniversity::vetserial::control_request::ack_response

(

void

)

[inline]

very thin wrapper of a common use-case; configures the header to respond to an ACK request

virtual void cornelluniversity::vetserial::control_request::deserialize

(

void

)

[virtual]

parses apart a received packet into the appropriate private members for use via the typical accessor process.

Exceptions:

	cornelluniversity::vetsim_badchksum	if the crc validation fails
	cornelluniversity::vetsim_exception	if the header size is deemed irregular
	cornelluniversity::vetsim_exception	if packet_ buffer is empty (null pointer)

Implements cornelluniversity::vetserial::base_command.

void cornelluniversity::vetserial::control_request::nak_request

(

void

)

[inline]

very thin wrapper of a common use-case; configures the header for a NAK request

void cornelluniversity::vetserial::control_request::nak_response

(

void

)

[inline]

very thin wrapper of a common use-case; configures the header to respond to a NAK request

virtual void cornelluniversity::vetserial::control_request::serialize

(

void

)

[inline, virtual]

Simply generates the header, utilizing the currently values of the private members, and leaves it in the internal buffers waiting for you to grab it.

See also:

header(void)

Implements cornelluniversity::vetserial::base_command.

void cornelluniversity::vetserial::control_request::set_responsive

(

void

)

[inline]

very thin wrapper of a common use-case; configures the header to request the target to ACK or NAK

---

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

• /users/dtb26/GITROOT/vs-vetserial-poc/src/vetprot.h

---