cbuf.h File Reference

Data Structures
struct	xbee_cbuf_t

Typedefs
typedef XBEE_BEGIN_DECLS struct xbee_cbuf_t	xbee_cbuf_t

Functions
void	xbee_cbuf_flush (xbee_cbuf_t FAR *cbuf)
	Flush the contents of the circular buffer. More...
uint_fast8_t	xbee_cbuf_free (xbee_cbuf_t FAR *cbuf)
	Returns the number of additional bytes that can be stored in the circular buffer. More...
uint_fast8_t	xbee_cbuf_get (xbee_cbuf_t *cbuf, void FAR *buffer, uint_fast8_t length)
	Read (and remove) multiple bytes from circular buffer. More...
int	xbee_cbuf_getch (xbee_cbuf_t FAR *cbuf)
	Remove and return the first byte of the circular buffer. More...
int	xbee_cbuf_init (xbee_cbuf_t FAR *cbuf, uint_fast8_t datasize)
	Initialize the fields of the circular buffer. More...
uint_fast8_t	xbee_cbuf_put (xbee_cbuf_t FAR *cbuf, const void FAR *buffer, uint_fast8_t length)
	Append multiple bytes to the end of a circular buffer. More...
int	xbee_cbuf_putch (xbee_cbuf_t FAR *cbuf, uint_fast8_t ch)
	Append a single byte to the circular buffer (if not full). More...
uint_fast8_t	xbee_cbuf_used (xbee_cbuf_t FAR *cbuf)
	Returns the number of bytes stored in the circular buffer. More...

Detailed Description

Circular buffer data type used by the OTA (Over-The-Air) firmware update client and transparent serial cluster.