#include "IOTCAPIs.h"
#include "P2PTunnelAPIs.h"

Functions
TUNNEL_API int32_t	P2PTunnelServer_Start_By_Nebula (NebulaDeviceCtx pDeviceCtx, tunnelSessionInfoExCB pfxSessionInfoExFn, const void pArg)
	Start a tunnel server with DTLS mode by Nebula.

TUNNEL_API int32_t	P2PTunnelAgent_Connect_By_Nebula (NebulaClientCtx pClientCtx, const char cszAmToken, const char *cszRealm, uint32_t nTimeoutMs)
	Connect to a tunnel server with DTLS mode by Nebula.

TUNNEL_API int32_t	P2PTunnelAgent_Connect_By_Nebula_Ex (NebulaClientCtx pClientCtx, const char cszValidation, const char *cszRealm, uint32_t nTimeoutMs)
	Connect to a tunnel server with DTLS mode by Nebula.

TUNNEL_API int32_t	P2PTunnelAgent_Connect_Stop_By_Nebula (NebulaClientCtx *pClientCtx)
	It's to stop the progressing of connection for Nebula.

Macro Definition Documentation

#define TUNNEL_API_DEPRECATED

Function Documentation

TUNNEL_API int32_t P2PTunnelAgent_Connect_By_Nebula	(	NebulaClientCtx *	pClientCtx,
		const char *	cszAmToken,
		const char *	cszRealm,
		uint32_t	nTimeoutMs
	)

Connect to a tunnel server with DTLS mode by Nebula.

This function used by a tunnel agent to connect the tunnel server with specified NebulaClientCtx

Parameters

pClientCtx	[in] The pointer of NebulaClientCtx that try to connect tunnel server
cszAmToken	[in] The rental token from AM server
cszRealm	[in] The realm of rental server needed for device
nTimeoutMs	[in] The timeout for this function in unit of millisecond, give 0 means return immediately

Returns

Tunnel Session ID if return value >= 0

TUNNEL_ER_NoERROR if connect successfully

Error code if return value < 0

TUNNEL_ER_NOT_INITIALIZED P2PModule has not been initialized in that tunnel agent
TUNNEL_ER_AUTH_FAILED The tunnel agent failed to connect to tunnel server because authentication data is illegal.
TUNNEL_ER_UID_UNLICENSE This UID is illegal or does not support P2PTunnel function
TUNNEL_ER_UID_NO_PERMISSION This UID not support P2PModule and TCP relay function
TUNNEL_ER_UID_NOT_SUPPORT_RELAY This UID can't setup connection through relay
TUNNEL_ER_DEVICE_NOT_ONLINE The specified tunnel server does not login to IOTC server yet
TUNNEL_ER_DEVICE_NOT_LISTENING The specified tunnel server is not listening for connection, it maybe busy at establishing connection with other tunnel agent
TUNNEL_ER_NETWORK_UNREACHABLE Internet is not available or firewall blocks connection
TUNNEL_ER_FAILED_SETUP_CONNECTION Can't connect to the tunnel server although it is online and listening for connection, it maybe caused by internet unstable situation
TUNNEL_ER_OPERATION_IS_INVALID Not support manual mode
TUNNEL_ER_HANDSHAKE_FAILED Create connection fail
TUNNEL_ER_REMOTE_NOT_SUPPORT_DTLS Remote not support DTLS
TUNNEL_ER_TIMEOUT Connect timeout

TUNNEL_API int32_t P2PTunnelAgent_Connect_By_Nebula_Ex	(	NebulaClientCtx *	pClientCtx,
		const char *	cszValidation,
		const char *	cszRealm,
		uint32_t	nTimeoutMs
	)

Connect to a tunnel server with DTLS mode by Nebula.

This function used by a tunnel agent to connect the tunnel server with specified NebulaClientCtx

Parameters

pClientCtx	[in] The pointer of NebulaClientCtx that try to connect tunnel server
cszValidation	[in] The validation for authentication
cszRealm	[in] The realm of rental server needed for device
nTimeoutMs	[in] The timeout for this function in unit of millisecond, give 0 means return immediately

Returns

Tunnel Session ID if return value >= 0

TUNNEL_ER_NoERROR if connect successfully

Error code if return value < 0

TUNNEL_ER_NOT_INITIALIZED P2PModule has not been initialized in that tunnel agent
TUNNEL_ER_AUTH_FAILED The tunnel agent failed to connect to tunnel server because authentication data is illegal.
TUNNEL_ER_UID_UNLICENSE This UID is illegal or does not support P2PTunnel function
TUNNEL_ER_UID_NO_PERMISSION This UID not support P2PModule and TCP relay function
TUNNEL_ER_UID_NOT_SUPPORT_RELAY This UID can't setup connection through relay
TUNNEL_ER_DEVICE_NOT_ONLINE The specified tunnel server does not login to IOTC server yet
TUNNEL_ER_DEVICE_NOT_LISTENING The specified tunnel server is not listening for connection, it maybe busy at establishing connection with other tunnel agent
TUNNEL_ER_NETWORK_UNREACHABLE Internet is not available or firewall blocks connection
TUNNEL_ER_FAILED_SETUP_CONNECTION Can't connect to the tunnel server although it is online and listening for connection, it maybe caused by internet unstable situation
TUNNEL_ER_OPERATION_IS_INVALID Not support manual mode
TUNNEL_ER_HANDSHAKE_FAILED Create connection fail
TUNNEL_ER_REMOTE_NOT_SUPPORT_DTLS Remote not support DTLS
TUNNEL_ER_TIMEOUT Connect timeout

TUNNEL_API int32_t P2PTunnelAgent_Connect_Stop_By_Nebula ( NebulaClientCtx * pClientCtx )

It's to stop the progressing of connection for Nebula.

This API is for a client to stop connecting to a device. We can use it to stop connecting when client blocks in P2PTunnelAgent_Connect_By_Nebula().

Parameters

pClientCtx [in] The NebulaClientCtx of tunnel connection

Returns

0 if success

Error code if return value < 0

TUNNEL_API int32_t P2PTunnelServer_Start_By_Nebula	(	NebulaDeviceCtx *	pDeviceCtx,
		tunnelSessionInfoExCB	pfxSessionInfoExFn,
		const void *	pArg
	)

Start a tunnel server with DTLS mode by Nebula.

This function will start a tunnel server with given NebulaDeviceCtx

Parameters

pDeviceCtx	[in] The pointer of NebulaDeviceCtx
pfxSessionInfoExFn	[in] The function pointer to get tunnel session information function. Can be NULL.
pArg	[in] User can give data pointer to pass to pfxTunnelServerAuthFn and pfxSessionInfoExFn when this call back function is triggered. Can be NULL.

Returns

TUNNEL_ER_NoERROR if start successfully

Error code if return value < 0

TUNNEL_ER_NOT_INITIALIZED P2PModule has not been initialized in that tunnel server
TUNNEL_ER_FAIL_CREATE_THREAD Failed to create thread
TUNNEL_ER_UID_NO_PERMISSION This UID not support P2PModule and TCP relay function
TUNNEL_ER_UID_UNLICENSE This UID is not licensed or expired