cornelluniversity::vetserial Namespace Reference

Classes
class	asynch_serial
	An asynchronous serial object based on the boost::asio library utilizing asynch reads. This implementation is specifically intended for multi-threaded environments. More...
class	base_command
	A pure virtual abstraction which serves as the basis of the vet serial protocol command structure. This handles packet management, dissecting incoming packets or creating new ones as needed. How the packets are assembled is determined in the pure virtual function execute() which must be over-ridden by any class inheriting from base_command. More...
class	control_request
	Implements a control (or header-only) command. Provides the interface required for minimal functionality required to manipulate and generate a header. More...
class	status_request
	Implements a control command soliciting a status check from the remote machine. More...
class	status_response
	Implements a control command responding to another machine's request for a status check. This object can be used to create new responses or to receive responses. More...
class	mp3_play_request
	Implements a request to initiate the playing of an MP3 device on the remote device. More...
class	mp3_stop_request
	Implements a request to to stop the playing of a track that is currently in playback on the remote device. More...
class	pubsub_message
	For use with the messaging API. The command acts as a proxy, blindly (de)serializing messages to be transported across the wire. More...
class	cpr_compression_state
	device to pc : chest compression stat notification More...
Typedefs
typedef enum cornelluniversity::vetserial::STATUS_TYPE	status_t
typedef enum cornelluniversity::vetserial::COMMAND_ID	cmnd_id
typedef enum cornelluniversity::vetserial::ERROR_CODE	err_code
typedef enum cornelluniversity::vetserial::FLAG_TYPE	flag_t
Enumerations
enum	STATUS_TYPE { STATUS_ERROR = 0x10, STATUS_READY = 0x20, STATUS_BUSY = 0x40 }
enum	COMMAND_ID {   CMD_CNTRL = 0x00, CMD_REQSTAT = 0x01, CMD_RSPSTAT = 0x02, CMD_PLAY_MP3 = 0x03,   CMD_STOP_MP3 = 0x04, CMD_MSG_PRXY = 0x05, CMD_CPR_CMPR = 0x06, CMD_MAXCMD = 0xFF }
enum	ERROR_CODE {   E_NOERROR = 0x00, E_DATAOOB = 0x01, E_NULLPTR = 0x02, E_CHKSUM = 0x03,   E_NONPROTO = 0xFE, E_UNKNOWN = 0xFF }
enum	FLAG_TYPE {   FLAG_REQ = 0x01, FLAG_ACK = 0x02, FLAG_NAK = 0x04, FLAG_DATA = 0x08,   FLAG_ERR = 0x10, FLAG_RDY = 0x20, FLAG_BUSY = 0x40, FLAG_RESRVD = 0x80 }

---

Typedef Documentation

typedef enum cornelluniversity::vetserial::STATUS_TYPE cornelluniversity::vetserial::status_t

typedef enum cornelluniversity::vetserial::COMMAND_ID cornelluniversity::vetserial::cmnd_id

typedef enum cornelluniversity::vetserial::ERROR_CODE cornelluniversity::vetserial::err_code

typedef enum cornelluniversity::vetserial::FLAG_TYPE cornelluniversity::vetserial::flag_t

---

Enumeration Type Documentation

enum cornelluniversity::vetserial::STATUS_TYPE

System status flags

Enumerator:

STATUS_ERROR	the system is in an error state
STATUS_READY	the system is in ready state
STATUS_BUSY	the system is in a busy state, and may be unresponsive

enum cornelluniversity::vetserial::COMMAND_ID

System command identifiers

Enumerator:

CMD_CNTRL	header-only control message
CMD_REQSTAT	status request
CMD_RSPSTAT	status response
CMD_PLAY_MP3	request to play an mp3 track
CMD_STOP_MP3	stop an mp3 track that is currently playing
CMD_MSG_PRXY	leverage the protocol to transport a pub/sub message
CMD_CPR_CMPR	chest compression state notice for the CPR mannequin
CMD_MAXCMD	upper-bound limit for command identifiers, establishes an 8-bit limit

enum cornelluniversity::vetserial::ERROR_CODE

System error codes

Enumerator:

E_NOERROR	operation completed successfully
E_DATAOOB	data values out of bounds for protocol defined constraints
E_NULLPTR	a null pointer was supplied where data was required
E_CHKSUM	bad checksum received
E_NONPROTO	a non-protocol related error has occured
E_UNKNOWN	no such error value, serves as upper-bound limit and establishes an 8-bit limit

enum cornelluniversity::vetserial::FLAG_TYPE

System control flags (a bit field)

Enumerator:

FLAG_REQ	OR with ACK, NAK, DATA to turn the call into a request for those operations
FLAG_ACK	enable to acknowledge a request or OR with FLAG_REQ to request a call be acknowledged
FLAG_NAK	enable to negatively acknowledge a request or OR with FLAG_REQ to request a call be negatively acknowledged
FLAG_DATA	enable to indicate the data-id field is populated or OR with FLAG_REQ to request the contents of the data-id field be echoed
FLAG_ERR	enable to indicate an error state. populate or interrogate (as appropriate) the error_code byte if this flag is set
FLAG_RDY	enable to indicate the system is in a ready state; able to receive and transmit commands
FLAG_BUSY	enable to indicate that the system is in a busy state is unable to participate in normal protocol semantics
FLAG_RESRVD	reserved for future use

---