This Code Implements The OpEN IP6 RADV API [OPENAPI_IP6RADV]

Functions
open_error_t	openapiIp6RtrRadvAdvLifetimeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get IPv6 router advertise lifetime. More...
open_error_t	openapiIp6RtrRadvAdvLifetimeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set IPv6 router advertise lifetime. More...
open_error_t	openapiIp6RtrRadvAdvMtuGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get IPv6 router advertise link mtu. More...
open_error_t	openapiIp6RtrRadvAdvMtuSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set IPv6 router advertise link mtu. More...
open_error_t	openapiIp6RtrRadvHopLimitUnspec (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
	Set IPv6 hop limit advertised on the interface to unspecified(0). More...
open_error_t	openapiIp6RtrRadvHopLimitUnspecGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
	Get whether IPv6 hop limit advertised on the interface to unspecified(0) More...
open_error_t	openapiIp6RtrRadvManagedFlagGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
	Get IPv6 router advertise managed flag. More...
open_error_t	openapiIp6RtrRadvManagedFlagSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
	Set IPv6 router advertise managed flag. More...
open_error_t	openapiIp6RtrRadvMaxAdvIntGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get IPv6 router advertise Maximum advertisement interval. More...
open_error_t	openapiIp6RtrRadvMaxAdvIntSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set IPv6 router advertise Maximum advertisement interval. More...
open_error_t	openapiIp6RtrRadvMinAdvIntGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get IPv6 router advertise Minimum advertisement interval. More...
open_error_t	openapiIp6RtrRadvMinAdvIntSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set IPv6 router advertise Minimum advertisement interval. More...
open_error_t	openapiIp6RtrRadvOtherCfgFlagGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
	Get IPv6 router advertise other-config flag. More...
open_error_t	openapiIp6RtrRadvOtherCfgFlagSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
	Set IPv6 router advertise other-config flag. More...
open_error_t	openapiIp6RtrRadvPrefixGet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix, uint32_t plen, uint32_t *prefLife, uint32_t *validLife, OPEN_BOOL_t *onLink, OPEN_BOOL_t *autonomous)
	Get IPv6 router as per prefix attributes. More...
open_error_t	openapiIp6RtrRadvPrefixSet (openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *prefix, uint32_t plen, uint32_t prefLife, uint32_t validLife, uint16_t lifeDecrFlags, OPEN_BOOL_t onLink, OPEN_BOOL_t autonomous)
	Set IPv6 router as per prefix attributes. More...
open_error_t	openapiIp6RtrRadvRtrPrefGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *val)
	Get IPv6 router preference. More...
open_error_t	openapiIp6RtrRadvRtrPrefSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t val)
	Set IPv6 router preference. More...
open_error_t	openapiIp6RtrRadvSuppressGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *flag)
	Get IPv6 router advertise suppression. More...
open_error_t	openapiIp6RtrRadvSuppressSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t flag)
	Set IPv6 router advertise suppression. More...

Detailed Description

Function Documentation

open_error_t openapiIp6RtrRadvAdvLifetimeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get IPv6 router advertise lifetime.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	Pointer to value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvAdvLifetimeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set IPv6 router advertise lifetime.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	Value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvAdvMtuGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get IPv6 router advertise link mtu.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	Pointer to MTU value

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvAdvMtuSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set IPv6 router advertise link mtu.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	MTU value

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvHopLimitUnspec	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	flag
	)

Set IPv6 hop limit advertised on the interface to unspecified(0).

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvHopLimitUnspecGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	flag
	)

Get whether IPv6 hop limit advertised on the interface to unspecified(0)

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvManagedFlagGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	flag
	)

Get IPv6 router advertise managed flag.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvManagedFlagSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	flag
	)

Set IPv6 router advertise managed flag.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvMaxAdvIntGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get IPv6 router advertise Maximum advertisement interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	Pointer to value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvMaxAdvIntSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set IPv6 router advertise Maximum advertisement interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	Value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvMinAdvIntGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get IPv6 router advertise Minimum advertisement interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	Pointer to value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvMinAdvIntSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set IPv6 router advertise Minimum advertisement interval.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	Value in seconds

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvOtherCfgFlagGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	flag
	)

Get IPv6 router advertise other-config flag.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvOtherCfgFlagSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	flag
	)

Set IPv6 router advertise other-config flag.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvPrefixGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_inet_addr_t *	prefix,
		uint32_t	plen,
		uint32_t *	prefLife,
		uint32_t *	validLife,
		OPEN_BOOL_t *	onLink,
		OPEN_BOOL_t *	autonomous
	)

Get IPv6 router as per prefix attributes.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	prefix	Pointer to prefix
[in]	plen	Prefix length
[out]	prefLife	Preferred life
[out]	validLife	Valid life
[out]	onLink	Onlink flag (OPEN_TRUE or OPEN_FALSE)
[out]	autonomous	Autonomous flag (OPEN_TRUE or OPEN_FALSE)

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvPrefixSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		open_inet_addr_t *	prefix,
		uint32_t	plen,
		uint32_t	prefLife,
		uint32_t	validLife,
		uint16_t	lifeDecrFlags,
		OPEN_BOOL_t	onLink,
		OPEN_BOOL_t	autonomous
	)

Set IPv6 router as per prefix attributes.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	prefix	Pointer to prefix
[in]	plen	Prefix length
[in]	prefLife	Preferred life
[in]	validLife	Valid life
[in]	lifeDecrFlags	Flags for lifetime decrement mode
[in]	onLink	Onlink flag (OPEN_TRUE or OPEN_FALSE)
[in]	autonomous	Autonomous flag (OPEN_TRUE or OPEN_FALSE)

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvRtrPrefGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	val
	)

Get IPv6 router preference.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	val	Pointer to preference value

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvRtrPrefSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t	val
	)

Set IPv6 router preference.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	val	Preference value

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvSuppressGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t *	flag
	)

Get IPv6 router advertise suppression.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[out]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.

open_error_t openapiIp6RtrRadvSuppressSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_BOOL_t	flag
	)

Set IPv6 router advertise suppression.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ifNum	Internal Interface Number
[in]	flag	OPEN_TRUE or OPEN_FALSE

Return values

OPEN_E_UNAVAIL	Feature is not supported
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.25

Examples:

ip6radv_example.c.