Definitions

Detailed Description

Data Structures
struct	_gxPLFilter
	Describe a xPL filter. More...
struct	_gxPLId
	Describe a source or destination xPL identifier. More...
struct	_gxPLIoAddr
	Describe a network address. More...
struct	_gxPLIoXBeeSetting
	Describe a XBee configuration. More...
struct	_gxPLSchema
	Describe a xPL schema. More...
struct	_gxPLSetting
	Describe a gxPLApplication configuration. More...

Macros
#define	GXPL_CLASS_MAX   8
	Maximum number of characters allowed for schema class.
#define	GXPL_DEFAULT_BAUDRATE   38400
	default baudrate for serial iolayer
#define	GXPL_DEFAULT_FLOW   SERIAL_FLOW_RTSCTS
	default baudrate for serial iolayer
#define	GXPL_DEVICEID_MAX   8
	Maximum number of characters allowed for device ID.
#define	GXPL_GETOPT   "i:n:B:W:dDr"
	getopt short options used by gxPLSettingFromCommandArgs()
#define	GXPL_HOP_MAX   9
	Maximum number of hop count.
#define	GXPL_INSTANCEID_MAX   16
	Maximum number of characters allowed for instance ID.
#define	GXPL_NAME_MAX   16
	Maximum number of characters allowed for a name of a name/value pair.
#define	GXPL_TYPE_MAX   8
	Maximum number of characters allowed for schema type.
#define	GXPL_VENDORID_MAX   8
	Maximum number of characters allowed for vendor ID.
#define	XPL_PORT   3865

Typedefs
typedef struct _gxPLFilter	gxPLFilter
	Describe a xPL filter.
typedef struct _gxPLId	gxPLId
	Describe a source or destination xPL identifier.
typedef struct _gxPLIoAddr	gxPLIoAddr
	Describe a network address.
typedef struct _gxPLIoXBeeSetting	gxPLIoXBeeSetting
	Describe a XBee configuration.
typedef struct _gxPLSchema	gxPLSchema
	Describe a xPL schema.
typedef struct _gxPLSetting	gxPLSetting
	Describe a gxPLApplication configuration.

Enumerations
enum	gxPLConfigurableType { gxPLConfigOptional, gxPLConfigMandatory, gxPLConfigReconf }
	xPL Configurable Type
enum	gxPLConnectType { gxPLConnectStandAlone, gxPLConnectViaHub, gxPLConnectAuto }
	xPL Connection mode More...
enum	gxPLHeartbeatType { gxPLHeartbeatHello = 0, gxPLHeartbeatGoodbye = 1 }
	Heartbeat type.
enum	gxPLIoFunc {   gxPLIoFuncNone = 0, gxPLIoFuncPoll, gxPLIoFuncGetIface, gxPLIoFuncGetBcastAddr,   gxPLIoFuncGetNetInfo, gxPLIoFuncGetLocalAddrList, gxPLIoFuncNetAddrToString, gxPLIoFuncNetAddrFromString,   gxPLIoFuncError = -1 }
	Possible xPL ioctl call.
enum	gxPLMessageState {   gxPLMessageStateInit = 0, gxPLMessageStateHeader, gxPLMessageStateHeaderHop, gxPLMessageStateHeaderSource,   gxPLMessageStateHeaderTarget, gxPLMessageStateHeaderEnd, gxPLMessageStateSchema, gxPLMessageStateBodyBegin,   gxPLMessageStateBody, gxPLMessageStateBodyEnd, gxPLMessageStateEnd, gxPLMessageStateError = -1 }
	Decoding states of a message.
enum	gxPLMessageType {   gxPLMessageAny, gxPLMessageCommand, gxPLMessageStatus, gxPLMessageTrigger,   gxPLMessageUnknown = -1 }
	Possible xPL message types.
enum	gxPLNetFamily {   gxPLNetFamilyUnknown = 0, gxPLNetFamilyInet = 2, gxPLNetFamilyInet4 = gxPLNetFamilyInet, gxPLNetFamilyInet6 = gxPLNetFamilyInet | 1,   gxPLNetFamilyZigbee = 4, gxPLNetFamilyZigbee16 = gxPLNetFamilyZigbee, gxPLNetFamilyZigbee64 = gxPLNetFamilyZigbee | 1 }
	Net families. More...

Macro Definition Documentation

#define XPL_PORT   3865

Communications between xPL applications on a Local Area Network (LAN) use UDP on port 3865

Definition at line 71 of file defs.h.

Enumeration Type Documentation

enum gxPLConnectType

xPL Connection mode

Enumerator
gxPLConnectStandAlone	listen on xPL port
gxPLConnectViaHub	listen on a client port

Definition at line 126 of file defs.h.

             {
  gxPLConnectStandAlone, 
  gxPLConnectViaHub,     
  gxPLConnectAuto
} gxPLConnectType;

enum gxPLNetFamily

Net families.

Enumerator
gxPLNetFamilyInet	family & gxPLNetFamilyInet -> true for two revisions of IP (v4 and v6)

Definition at line 163 of file defs.h.

             {
  gxPLNetFamilyUnknown  = 0,
  gxPLNetFamilyInet     = 2, 
  gxPLNetFamilyInet4    = gxPLNetFamilyInet,
  gxPLNetFamilyInet6    = gxPLNetFamilyInet | 1,
  gxPLNetFamilyZigbee   = 4,
  gxPLNetFamilyZigbee16 = gxPLNetFamilyZigbee,
  gxPLNetFamilyZigbee64 = gxPLNetFamilyZigbee | 1
} gxPLNetFamily;