openapi_bonjour.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2022-2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_bonjour.h
*
* @purpose   OpEN bonjour API
*
* @component OPEN
*
* @create    11/25/2022
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_BONJOUR_H_INCLUDED
#define OPENAPI_BONJOUR_H_INCLUDED

#include "openapi_common.h"

/* Bonjour Network Service Types */
typedef enum
{
  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,
} OPEN_BONJOUR_SERVICE_TYPE_t;

/* These values shouldn't be changed -> */
#define OPEN_BONJOUR_SERVICE_NAME_MAX_LEN       64
#define OPEN_BONJOUR_SERVICE_TYPE_MAX_LEN       1005
#define OPEN_BONJOUR_SERVICE_DOMAIN_MAX_LEN     1005
#define OPEN_BONJOUR_SERVICE_TXT_MAX_LEN        256
/* <-These values shouldn't be changed */


/* Published Service Entry */
typedef struct
{
  OPEN_BONJOUR_SERVICE_TYPE_t service;
  OPEN_BOOL_t           published;
  unsigned char         serviceName[OPEN_BONJOUR_SERVICE_NAME_MAX_LEN];
  unsigned char         serviceType[OPEN_BONJOUR_SERVICE_TYPE_MAX_LEN];
  unsigned char         serviceDomain[OPEN_BONJOUR_SERVICE_DOMAIN_MAX_LEN];
  uint32_t              servicePort;
  unsigned char         serviceText[OPEN_BONJOUR_SERVICE_TXT_MAX_LEN];
} OPEN_BONJOUR_SERVICE_INFO_t;

/*************************************************************************/
open_error_t openapiBonjourAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiBonjourAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode);

/*************************************************************************/
open_error_t openapiBonjourDebugLevel1Set(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiBonjourDebugLevel1Get(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode);

/*************************************************************************/
open_error_t openapiBonjourDebugLevel2Set(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiBonjourDebugLevel2Get(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode);

/*************************************************************************/
open_error_t openapiBonjourPublishedServiceGetNext(openapiClientHandle_t *client_handle, OPEN_BONJOUR_SERVICE_INFO_t *pServiceEntry);

/*************************************************************************/
open_error_t openapiBonjourPublishedServiceGet(openapiClientHandle_t *client_handle, OPEN_BONJOUR_SERVICE_INFO_t *pServiceEntry);

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

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


#endif /* OPENAPI_BONJOUR_H_INCLUDED */