socket_frames.h File Reference

Frame definitions and support functions for Extended Socket frames (0x40-0x4F and 0xC0-0xCF). More...

#include "xbee/platform.h"

Go to the source code of this file.

Data Structures
struct	xbee_frame_sock_create_t
	Format of XBee API frame type 0x40 (XBEE_FRAME_SOCK_CREATE). More...
struct	xbee_header_sock_option_req_t
	Header of XBee API frame type 0x41 (XBEE_FRAME_SOCK_OPTION_REQ); sent from host to XBee. More...
struct	xbee_frame_sock_option_resp_t
	Format of XBee API frame type 0xC1 (XBEE_FRAME_SOCK_OPTION_RESP); sent from XBee to host. More...
struct	xbee_header_sock_connect_t
	Header of XBee API frame type 0x42 (XBEE_FRAME_SOCK_CONNECT); sent from host to XBee. More...
struct	xbee_frame_sock_close_t
	Format of XBee API frame type 0x43 (XBEE_FRAME_SOCK_CLOSE). More...
struct	xbee_header_sock_send_t
	Header of XBee API frame type 0x44 (XBEE_FRAME_SOCK_SEND); sent from host to XBee. More...
struct	xbee_header_sock_sendto_t
	Header of XBee API frame type 0x45 (XBEE_FRAME_SOCK_SENDTO); sent from host to XBee. More...
struct	xbee_frame_sock_bind_listen_t
	Format of XBee API frame type 0x46 (XBEE_FRAME_SOCK_BIND_LISTEN). More...
struct	xbee_frame_sock_shared_resp_t
	Format of multiple XBee API frame types sent from XBee to host: 0xC0 (XBEE_FRAME_SOCK_CREATE_RESP) 0xC2 (XBEE_FRAME_SOCK_CONNECT_RESP) 0xC3 (XBEE_FRAME_SOCK_CLOSE_RESP) 0xC6 (XBEE_FRAME_SOCK_LISTEN_RESP) More...
struct	xbee_frame_sock_ipv4_client_t
	Format of XBee API frame type 0xCC (XBEE_FRAME_SOCK_IPV4_CLIENT); sent from XBee to host for new connections on a listening socket. More...
struct	xbee_frame_sock_receive_t
	Format of XBee API frame type 0xCD (XBEE_FRAME_SOCK_RECEIVE); sent from XBee to host when data arrives on a connected socket. More...
struct	xbee_frame_sock_receive_from_t
	Format of XBee API frame type 0xCE (XBEE_FRAME_SOCK_RECEIVE_FROM); sent from XBee to host when a datagram arrives on a bound UDP socket. More...
struct	xbee_frame_sock_state_t
	Format of XBee API frame type 0xCF (XBEE_FRAME_SOCK_STATE); sent from XBee to host when a socket's state changes. More...

Macros
#define	XBEE_SOCK_STATUS_SUCCESS   0x00
	Status codes used by multiple socket response frame types. More...
#define	XBEE_SOCK_STATUS_INVALID_PARAM   0x01
	invalid parameters
#define	XBEE_SOCK_STATUS_FAILED_TO_READ   0x02
	failed to retrieve option
#define	XBEE_SOCK_STATUS_IN_PROGRESS   0x03
	connect already in progress
#define	XBEE_SOCK_STATUS_CONNECTED   0x04
	connected/bound/listening
#define	XBEE_SOCK_STATUS_UNKNOWN   0x05
	unknown error
#define	XBEE_SOCK_STATUS_BAD_SOCKET   0x20
	invalid socket ID
#define	XBEE_SOCK_STATUS_OFFLINE   0x22
	not registered to network
#define	XBEE_SOCK_STATUS_INTERNAL_ERR   0x31
	internal error
#define	XBEE_SOCK_STATUS_RESOURCE_ERR   0x32
	resource error, try later
#define	XBEE_SOCK_STATUS_BAD_PROTOCOL   0x7B
	invalid protocol
#define	XBEE_SOCK_SOCKET_ID_INVALID   0xFF
	The 8-bit Socket ID is never 0xFF, except in Socket Create Response when socket creation wasn't successful. More...
#define	XBEE_FRAME_SOCK_CREATE   0x40
	Frame Type: Extended Socket Create.
#define	XBEE_FRAME_SOCK_OPTION_REQ   0x41
	Frame Type: Extended Socket Option Request.
#define	XBEE_FRAME_SOCK_OPTION_RESP   0xC1
	Frame Type: Extended Socket Option Response.
#define	XBEE_FRAME_SOCK_CONNECT   0x42
	Frame Type: Extended Socket Connect.
#define	XBEE_FRAME_SOCK_CLOSE   0x43
	Frame Type: Extended Socket Close.
#define	XBEE_FRAME_SOCK_SEND   0x44
	Frame Type: Extended Socket Send.
#define	XBEE_FRAME_SOCK_SENDTO   0x45
	Frame Type: Extended Socket Sendto.
#define	XBEE_FRAME_SOCK_BIND_LISTEN   0x46
	Frame Type: Extended Socket Bind/Listen.
#define	XBEE_FRAME_SOCK_CREATE_RESP   0xC0
	Frame Type: Extended Socket Create Response.
#define	XBEE_FRAME_SOCK_CONNECT_RESP   0xC2
	Frame Type: Extended Socket Connect Response.
#define	XBEE_FRAME_SOCK_CLOSE_RESP   0xC3
	Frame Type: Extended Socket Close Response.
#define	XBEE_FRAME_SOCK_LISTEN_RESP   0xC6
	Frame Type: Extended Socket Bind/Listen Response.
#define	XBEE_FRAME_SOCK_IPV4_CLIENT   0xCC
	Frame Type: Extended Socket IPv4 Client.
#define	XBEE_FRAME_SOCK_RECEIVE   0xCD
	Frame Type: Extended Socket Receive.
#define	XBEE_FRAME_SOCK_RECEIVE_FROM   0xCE
	Frame Type: Extended Socket Receive From.
#define	XBEE_FRAME_SOCK_STATE   0xCF
	Frame Type: Extended Socket State.
#define	XBEE_SOCK_STR_BUF_SIZE   40
	Buffer size used for xbee_sock_status_str() and xbee_sock_state_str().

Functions
const char *	xbee_sock_status_str (uint8_t status, char buffer[XBEE_SOCK_STR_BUF_SIZE])
	Get a description of an XBEE_SOCK_STATUS_xxx value (returned in multiple socket response frame types) for error messages. More...
const char *	xbee_sock_state_str (uint8_t state, char buffer[XBEE_SOCK_STR_BUF_SIZE])
	Get a description of an XBEE_SOCK_STATE_xxx value (returned in an XBEE_FRAME_SOCK_STATE) for error messages. More...

Detailed Description

Frame definitions and support functions for Extended Socket frames (0x40-0x4F and 0xC0-0xCF).

For use with XBee Cellular firmware versions ending in x15 or later.