xbee_xmodem_state_t Struct Reference

Structure used to track the state of an Xmodem send. More...

#include "xbee/xmodem.h"

Data Fields
uint16_t	flags
	flags for tracking state of transfer
uint16_t	packet_num
	current packet number; starts at 1 and low byte used in block headers
uint16_t	timer
	timer value used to hold low word of xbee_millisecond_timer()
enum xbee_xmodem_state	state
	current state of transfer
uint_fast8_t	tries
	of tries left before giving up
int	offset
	offset into packet being sent
char FAR *	buffer
	buffer we can use
struct {
xbee_xmodem_read_fn   read
	source of bytes to send
void FAR *   context
	context for file.read()
}	file
	function and context to read source of sent data
struct {
xbee_xmodem_read_fn   read
	read response bytes from target
xbee_xmodem_write_fn   write
	send blocks to target
void FAR *   context
	context for stream.read & .write
}	stream
	functions and context to communicate with target device

Detailed Description

Structure used to track the state of an Xmodem send.

Field Documentation

void FAR* context

context for file.read()

context for stream.read & .write

Referenced by _xbee_xmodem_getchar(), _xbee_xmodem_putchar(), xbee_xmodem_set_source(), xbee_xmodem_set_stream(), xbee_xmodem_tx_init(), and xbee_xmodem_tx_tick().

xbee_xmodem_read_fn read

source of bytes to send

read response bytes from target

Referenced by _xbee_xmodem_getchar(), xbee_xmodem_set_source(), xbee_xmodem_set_stream(), xbee_xmodem_tx_init(), and xbee_xmodem_tx_tick().

---

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

• include/xbee/xmodem.h