ipv4.h File Reference

#include "xbee/platform.h"
#include "xbee/device.h"

Go to the source code of this file.

Data Structures
struct	xbee_header_transmit_ipv4_t
	Header of XBee API frame type 0x20 (XBEE_FRAME_TRANSMIT_IPV4); sent from host to XBee. More...
struct	xbee_frame_receive_ipv4_t
	Format of XBee API frame type 0xB0 (XBEE_FRAME_RECEIVE_IPV4); received from XBee by host. More...
struct	xbee_ipv4_envelope_t

Macros
#define	XBEE_FRAME_TRANSMIT_IPV4   0x20
	Frame Type: Transmit IPv4 data. [Wi-Fi, Cellular].
#define	XBEE_FRAME_RECEIVE_IPV4   0xB0
	Frame Type: Sent upon receiving IPv4 data. [Wi-Fi, Cellular].
#define	XBEE_IPV4_MAX_PAYLOAD   1500
	Maximum number of bytes in the payload of an IPv4 transmit or receive frame.

Functions
int	xbee_ipv4_envelope_reply (xbee_ipv4_envelope_t FAR *reply, const xbee_ipv4_envelope_t FAR *original)
	Address a reply envelope using fields from a received envelope. More...
void	xbee_ipv4_envelope_dump (const xbee_ipv4_envelope_t FAR *envelope, bool_t include_payload)
	Print the contents of an IPv4 envelope to stdout.
int	xbee_ipv4_envelope_send (const xbee_ipv4_envelope_t FAR *envelope)
	Send an IPv4 packet. More...
int	xbee_ipv4_receive_dump (xbee_dev_t *xbee, const void FAR *raw, uint16_t length, void FAR *context)
	Dump received IPv4 frame to stdout. More...
int	xbee_ipv4_ntoa (char buffer[16], uint32_t ip_be)
	Format a big-endian IP address from an XBee frame as a "dotted quad", four decimal numbers separated by '. More...
int	xbee_ipv4_aton (const char *cp, uint32_t *ip_be)
	Takes an address separated by '. More...
char *	xbee_ipv4_protocol_str (char buffer[8], uint8_t protocol)
	A string description of the "protocol" byte from an XBee IPv4 frame. More...

XBEE_IPV4_PROTOCOL_xxx
Values for protocol member of xbee_header_transmit_ipv4_t and xbee_header_receive_ipv4_t.
#define	XBEE_IPV4_PROTOCOL_UDP   0
	UDP.
#define	XBEE_IPV4_PROTOCOL_TCP   1
	TCP.
#define	XBEE_IPV4_PROTOCOL_SSL   4
	SSL.

XBEE_IPV4_TX_OPT_xxx
Values for options member of xbee_header_transmit_ipv4_t.
#define	XBEE_IPV4_TX_OPT_NONE   0
	None.
#define	XBEE_IPV4_TX_OPT_TCP_CLOSE   (1<<1)
	TCP Close.