airkiss.h 文件参考

浏览源代码.

结构体
struct	airkiss_config_t

类型定义
typedef void *(*	airkiss_memset_fn )(void *ptr, int value, unsigned int num)
typedef void *(*	airkiss_memcpy_fn )(void *dst, const void *src, unsigned int num)
typedef int(*	airkiss_memcmp_fn )(const void *ptr1, const void *ptr2, unsigned int num)
typedef int(*	airkiss_printf_fn )(const char *format,...)

枚举
enum	airkiss_lan_ret_t {   AIRKISS_LAN_ERR_OVERFLOW = -5, AIRKISS_LAN_ERR_CMD = -4, AIRKISS_LAN_ERR_PAKE = -3, AIRKISS_LAN_ERR_PARA = -2,   AIRKISS_LAN_ERR_PKG = -1, AIRKISS_LAN_CONTINUE = 0, AIRKISS_LAN_SSDP_REQ = 1, AIRKISS_LAN_PAKE_READY = 2 }
enum	airkiss_lan_cmdid_t { AIRKISS_LAN_SSDP_REQ_CMD = 0x1, AIRKISS_LAN_SSDP_RESP_CMD = 0x1001, AIRKISS_LAN_SSDP_NOTIFY_CMD = 0x1002 }

函数
const char *	airkiss_version (void)
	Get airkiss lib version. 更多...
int	airkiss_lan_recv (const void *body, unsigned short length, const airkiss_config_t *config)
	Receive UDP packet and input this API for analyzing. 更多...
int	airkiss_lan_pack (airkiss_lan_cmdid_t ak_lan_cmdid, void *appid, void *deviceid, void *_datain, unsigned short inlength, void *_dataout, unsigned short *outlength, const airkiss_config_t *config)
	Packaging the UDP packet to send. 更多...

类型定义说明

typedef void*(* airkiss_memset_fn)(void *ptr, int value, unsigned int num)

typedef void*(* airkiss_memcpy_fn)(void *dst, const void *src, unsigned int num)

typedef int(* airkiss_memcmp_fn)(const void *ptr1, const void *ptr2, unsigned int num)

typedef int(* airkiss_printf_fn)(const char *format,...)

枚举类型说明

enum airkiss_lan_ret_t

枚举值
AIRKISS_LAN_ERR_OVERFLOW
AIRKISS_LAN_ERR_CMD
AIRKISS_LAN_ERR_PAKE
AIRKISS_LAN_ERR_PARA
AIRKISS_LAN_ERR_PKG
AIRKISS_LAN_CONTINUE
AIRKISS_LAN_SSDP_REQ
AIRKISS_LAN_PAKE_READY

{
    /* the length of the data buffer is lack*/
    AIRKISS_LAN_ERR_OVERFLOW = -5,

    /* Do not support the type of instruction */
    AIRKISS_LAN_ERR_CMD = -4,

    /* Error reading data package */
    AIRKISS_LAN_ERR_PAKE = -3,

    /* Error function passing parameters */
    AIRKISS_LAN_ERR_PARA = -2,

    /* Packet data error */
    AIRKISS_LAN_ERR_PKG = -1,

    /* Message format is correct */
    AIRKISS_LAN_CONTINUE = 0,

    /* Find equipment request packet is received */
    AIRKISS_LAN_SSDP_REQ = 1,

    /* Packet packaging complete */
    AIRKISS_LAN_PAKE_READY = 2


} airkiss_lan_ret_t;

enum airkiss_lan_cmdid_t

枚举值
AIRKISS_LAN_SSDP_REQ_CMD
AIRKISS_LAN_SSDP_RESP_CMD
AIRKISS_LAN_SSDP_NOTIFY_CMD

{
    AIRKISS_LAN_SSDP_REQ_CMD = 0x1,
    AIRKISS_LAN_SSDP_RESP_CMD = 0x1001,
    AIRKISS_LAN_SSDP_NOTIFY_CMD = 0x1002
} airkiss_lan_cmdid_t;

函数说明

const char* airkiss_version

(

void

)

Get airkiss lib version.

注意

The lenth of version is unknown

参数

null.

返回

const char*

int airkiss_lan_recv	(	const void *	body,
		unsigned short	length,
		const airkiss_config_t *	config
	)

Receive UDP packet and input this API for analyzing.

注意

null.

参数

const	void* body : The start of the UDP message body data pointer.
unsigned	short length : the effective length of data.
const	airkiss_config_t* config : input struct airkiss_config_t

返回

>=0 : succeed (reference airkiss_lan_ret_t)

<0 : error code (reference airkiss_lan_ret_t)

int airkiss_lan_pack	(	airkiss_lan_cmdid_t	ak_lan_cmdid,
		void *	appid,
		void *	deviceid,
		void *	_datain,
		unsigned short	inlength,
		void *	_dataout,
		unsigned short *	outlength,
		const airkiss_config_t *	config
	)

Packaging the UDP packet to send.

注意

null.

参数

airkiss_lan_cmdid_t	ak_lan_cmdid : The packet type.
void*	appid : Vendor's Wechat public number id.
void*	deviceid : device model id.
void*	_datain : the data to be sent.
unsigned	short inlength : the lenth of data to be sent.
void*	_dataout : Data buffer addr.
unsigned	short* outlength : the size of data buffer.
const	airkiss_config_t* config : input struct airkiss_config_t

返回

>=0 : succeed (reference airkiss_lan_ret_t)

<0 : error code (reference airkiss_lan_ret_t)