OpEN Bonjour API [OPENAPI_BONJOUR]

Data Structures
struct	OPEN_BONJOUR_SERVICE_INFO_t

Macros
#define	OPEN_BONJOUR_SERVICE_DOMAIN_MAX_LEN   1005
#define	OPEN_BONJOUR_SERVICE_NAME_MAX_LEN   64
#define	OPEN_BONJOUR_SERVICE_TXT_MAX_LEN   256
#define	OPEN_BONJOUR_SERVICE_TYPE_MAX_LEN   1005

Enumerations
enum	OPEN_BONJOUR_SERVICE_TYPE_t {   OPEN_BONJOUR_SERVICE_FIRST = 0, OPEN_BONJOUR_SERVICE_GENERIC = OPEN_BONJOUR_SERVICE_FIRST, OPEN_BONJOUR_SERVICE_HTTP, OPEN_BONJOUR_SERVICE_HTTPS,   OPEN_BONJOUR_SERVICE_TELNET, OPEN_BONJOUR_SERVICE_SSH, OPEN_BONJOUR_SERVICE_LAST }

Functions
open_error_t	openapiBonjourAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets admin mode of Bonjour responder. More...
open_error_t	openapiBonjourAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets admin mode of Bonjour responder. More...
open_error_t	openapiBonjourDebugLevel1Get (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets the level-1 tracing mode of Bonjour responder. More...
open_error_t	openapiBonjourDebugLevel1Set (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the level-1 tracing mode of Bonjour responder. More...
open_error_t	openapiBonjourDebugLevel2Get (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
	Gets the level-2 tracing mode of Bonjour responder. More...
open_error_t	openapiBonjourDebugLevel2Set (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
	Sets the level-2 tracing mode of Bonjour responder. More...
open_error_t	openapiBonjourPublishedServiceGet (openapiClientHandle_t *client_handle, OPEN_BONJOUR_SERVICE_INFO_t *pServiceEntry)
	Gets information about the published service. More...
open_error_t	openapiBonjourPublishedServiceGetNext (openapiClientHandle_t *client_handle, OPEN_BONJOUR_SERVICE_INFO_t *pServiceEntry)
	Gets information about the next published service. More...
open_error_t	openapiBonjourServiceGetByIndex (openapiClientHandle_t *client_handle, uint32_t index, OPEN_BONJOUR_SERVICE_INFO_t *pServiceEntry)
	Gets information about the published service corresponding to index. More...
open_error_t	openapiBonjourServiceIndexGetNext (openapiClientHandle_t *client_handle, uint32_t index, uint32_t *pNextIndex)
	Gets information about the next published service index. More...

Detailed Description

Function Documentation

open_error_t openapiBonjourAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets admin mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Bonjour admin mode state

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets admin mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets admin mode of Bonjour responder to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourDebugLevel1Get	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets the level-1 tracing mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Bonjour level-1 tracing state

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourDebugLevel1Set	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets the level-1 tracing mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets level-1 tracing mode of Bonjour responder to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourDebugLevel2Get	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	pMode
	)

Gets the level-2 tracing mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[out]	pMode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches Bonjour level-2 tracing state

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourDebugLevel2Set	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	mode
	)

Sets the level-2 tracing mode of Bonjour responder.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Mode [Enable/Disable]

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API sets level-2 tracing mode of Bonjour responder to enable/disable

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourPublishedServiceGet	(	openapiClientHandle_t *	client_handle,
		OPEN_BONJOUR_SERVICE_INFO_t *	pServiceEntry
	)

Gets information about the published service.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	pServiceEntry	Published service info.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches information about the published service

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourPublishedServiceGetNext	(	openapiClientHandle_t *	client_handle,
		OPEN_BONJOUR_SERVICE_INFO_t *	pServiceEntry
	)

Gets information about the next published service.

Parameters

[in]	client_handle	client handle from registration API
[in,out]	pServiceEntry	Published service info. Should be set to all zeroes in order to get the first connection.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches information about the next published service

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourServiceGetByIndex	(	openapiClientHandle_t *	client_handle,
		uint32_t	index,
		OPEN_BONJOUR_SERVICE_INFO_t *	pServiceEntry
	)

Gets information about the published service corresponding to index.

Parameters

[in]	client_handle	client handle from registration API
[in]	index	Service index
[out]	pServiceEntry	Published service info.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches information about the published service corresponding to index

OpEN API Version: 1.25

Examples:

bonjour_example.c.

open_error_t openapiBonjourServiceIndexGetNext	(	openapiClientHandle_t *	client_handle,
		uint32_t	index,
		uint32_t *	pNextIndex
	)

Gets information about the next published service index.

Parameters

[in]	client_handle	client handle from registration API
[in]	index	Service index
[out]	pNextIndex	Next service index.

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

This API fetches information about the next published service index

OpEN API Version: 1.25

Examples:

bonjour_example.c.