kii_thing_if_environment_impl.h File Reference

#include <kii_socket_callback.h>
#include <kii_task_callback.h>

Go to the source code of this file.

Functions
kii_socket_code_t	socket_connect_cb_impl (kii_socket_context_t *socket_context, const char *host, unsigned int port)
kii_socket_code_t	socket_send_cb_impl (kii_socket_context_t *socket_context, const char *buffer, size_t length)
kii_socket_code_t	socket_recv_cb_impl (kii_socket_context_t *socket_context, char *buffer, size_t length_to_read, size_t *out_actual_length)
kii_socket_code_t	socket_close_cb_impl (kii_socket_context_t *socket_context)
kii_socket_code_t	mqtt_connect_cb_impl (kii_socket_context_t *socket_context, const char *host, unsigned int port)
kii_socket_code_t	mqtt_send_cb_impl (kii_socket_context_t *socket_context, const char *buffer, size_t length)
kii_socket_code_t	mqtt_recv_cb_impl (kii_socket_context_t *socket_context, char *buffer, size_t length_to_read, size_t *out_actual_length)
kii_socket_code_t	mqtt_close_cb_impl (kii_socket_context_t *socket_context)
kii_task_code_t	task_create_cb_impl (const char *name, KII_TASK_ENTRY entry, void *param)
void	delay_ms_cb_impl (unsigned int msec)
void	logger_cb_impl (const char *format,...)

Function Documentation

void delay_ms_cb_impl

(

unsigned int

msec

)

Implementation of callback to delay task. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::delay_ms_cb of command handler and state updater.

Parameters

[in]

msec

millisecond to delay.

void logger_cb_impl	(	const char *	format,
			...
	)

Implementation of callback to log this SDK. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::logger_cb of command handler and state updater.

Parameters

[in]

format

outputted string format.

kii_socket_code_t mqtt_close_cb_impl

(

kii_socket_context_t *

socket_context

)

Implementation of callback to close MQTT socket. this SDK requirest to implement this function in each target environment.

This function is assigned to a field kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::mqtt_socket_close_cb of command handler.

Parameters

[in]

socket_context

context object.

Returns

If applications succeed to close socket, applications need to return KII_SOCKETC_OK. If applications fail to close socket, applications need to return KII_SOCKETC_FAIL. If applications want to pend returning success or fail, applications need to return KII_SOCKETC_AGAIN.

kii_socket_code_t mqtt_connect_cb_impl	(	kii_socket_context_t *	socket_context,
		const char *	host,
		unsigned int	port
	)

Implementation of callback for connect MQTT socket to server. this SDK requirest to implement this function in each target environment.

This function is assigned to a field kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::mqtt_socket_connect_cb of command handler.

Parameters

[in]	socket_context	context object.
[in]	host	host name.
[in]	port	port number.

Returns

If connection is succeeded, applications need to return KII_SOCKETC_OK. If connection is failed, applications need to return KII_SOCKETC_FAIL. If applications want to pend returning success or fail, applications need to return KII_SOCKETC_AGAIN.

kii_socket_code_t mqtt_recv_cb_impl	(	kii_socket_context_t *	socket_context,
		char *	buffer,
		size_t	length_to_read,
		size_t *	out_actual_length
	)

Implementation of callback to receive MQTT data from server. this SDK requirest to implement this function in each target environment.

This function is assigned to a field kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::mqtt_socket_recv_cb of command handler.

Parameters

[in]	socket_context	context object.
[out]	buffer	buffer to set receiving data.
[in]	length_to_read	buffer size.
[out]	out_actual_length	actual set data size.

Returns

If applications succeed to receive data and set the data to buffer, applications need to return KII_SOCKETC_OK. Applications also set data size to out_actual_length. If applications fail, applications need to return KII_HTTPC_FAIL. If applications want to wait to receive data, applications need to return KII_HTTPC_AGAIN. In this case, applications must not set receving data to buffer if some data is received.

kii_socket_code_t mqtt_send_cb_impl	(	kii_socket_context_t *	socket_context,
		const char *	buffer,
		size_t	length
	)

Implementation of callback to send MQTT data to server. this SDK requirest to implement this function in each target environment.

This function is assigned to a field kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::mqtt_socket_send_cb of command handler.

Parameters

[in]	socket_context	context object.
[in]	buffer	data to send server.
[in]	length	length of buffer.

Returns

If applications succeed to send data, applications need to return KII_SOCKETC_OK. If connection is failed. applications need to return KII_SOCKETC__FAIL. If applications don't want to send data, applications need to return KII_SOCKETC_AGAIN. In this case, this SDK pass same data to this function again.

kii_socket_code_t socket_close_cb_impl

(

kii_socket_context_t *

socket_context

)

Implementation of callback to close HTTP or HTTPS socket. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::close_cb of command handler and state updater.

Parameters

[in]

socket_context

context object.

Returns

If applications succeed to close socket, applications need to return KII_SOCKETC_OK. If applications fail to close socket, applications need to return KII_SOCKETC_FAIL. If applications want to pend returning success or fail, applications need to return KII_SOCKETC_AGAIN.

kii_socket_code_t socket_connect_cb_impl	(	kii_socket_context_t *	socket_context,
		const char *	host,
		unsigned int	port
	)

Implementation of callback to connect socket to HTTP or HTTPS server. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::connect_cb of command handler and state updater.

Parameters

[in]	socket_context	context object.
[in]	host	host name.
[in]	port	port number.

Returns

If connection is succeeded, applications need to return KII_SOCKETC_OK. If connection is failed, applications need to return KII_SOCKETC_FAIL. If applications want to pend returning success or fail, applications need to return KII_SOCKETC_AGAIN.

kii_socket_code_t socket_recv_cb_impl	(	kii_socket_context_t *	socket_context,
		char *	buffer,
		size_t	length_to_read,
		size_t *	out_actual_length
	)

Implementation of callback for receive data from HTTP or HTTPS server. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::recv_cb of command handler and state updater.

Parameters

[in]	socket_context	context object.
[out]	buffer	buffer to set receiving data.
[in]	length_to_read	buffer size.
[out]	out_actual_length	actual set data size.

Returns

If applications succeed to receive data and set the data to buffer, applications need to return KII_SOCKETC_OK. Applications also set data size to out_actual_length. If applications fail, applications need to return KII_HTTPC_FAIL. If applications want to wait to receive data, applications need to return KII_HTTPC_AGAIN. In this case, applications must not set receving data to buffer if some data is received.

kii_socket_code_t socket_send_cb_impl	(	kii_socket_context_t *	socket_context,
		const char *	buffer,
		size_t	length
	)

Implementation of callback to send data to HTTP or HTTPS server. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::send_cb of command handler and state updater.

Parameters

[in]	socket_context	context object.
[in]	buffer	data to send server.
[in]	length	length of buffer.

Returns

If applications succeed to send data, applications need to return KII_SOCKETC_OK. If connection is failed. applications need to return KII_SOCKETC__FAIL. If applications don't want to send data, applications need to return KII_SOCKETC_AGAIN. In this case, this SDK pass same data to this function again.

kii_task_code_t task_create_cb_impl	(	const char *	name,
		KII_TASK_ENTRY	entry,
		void *	param
	)

Implementation of callback to create task. this SDK requirest to implement this function in each target environment.

This function is assigned to fields kii_t::kii_core_t::kii_http_context_t::kii_http_context_t::task_create_cb of command handler and state updater.

Parameters

[in]	name	name of task.
[in]	entry	entry of task.
[in]	stk_start	start position of stack area.
[in]	stk_size	stack size of task
[in]	priority	priority of thisk

Returns

KII_TASKC_OK if succeed to create task. otherwise KII_TASKC_FAIL.