openapi_ip4dhcpclient.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 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_ip4dhcpclient.h
*
* @purpose   This code implements the OpEN IPv4 DHCP Client API
*
* @component OPEN
*
* @create    02/08/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_IP4DHCPCLIENT_H_INCLUDED
#define OPENAPI_IP4DHCPCLIENT_H_INCLUDED

#include "openapi_common.h" 


typedef enum
{
  OPEN_MGMT_SERVICEPORT = 0,                        
  OPEN_MGMT_NETWORKPORT,
  OPEN_MGMT_IPPORT                                  
} OPEN_MGMT_PORT_TYPE_t;  

typedef enum
{
  OPEN_DHCPSTATE_INIT = 1,
  OPEN_DHCPSTATE_SELECTING,
  OPEN_DHCPSTATE_REQUESTING,
  OPEN_DHCPSTATE_REQUEST_RECV,
  OPEN_DHCPSTATE_BOUND,
  OPEN_DHCPSTATE_RENEWING,
  OPEN_DHCPSTATE_RENEW_RECV,
  OPEN_DHCPSTATE_REBINDING,
  OPEN_DHCPSTATE_REBIND_RECV,
  OPEN_DHCPSTATE_BOOTP_FALLBACK,
  OPEN_DHCPSTATE_NOTBOUND,
  OPEN_DHCPSTATE_FAILED,
  OPEN_DHCPSTATE_DO_RELEASE,
  OPEN_DHCPSTATE_INFORM_REQUEST,
  OPEN_DHCPSTATE_INFORM_ACK_WAIT,
  OPEN_DHCPSTATE_INFORM_FAILED,
  OPEN_DHCPSTATE_INFORM_BOUND

} OPEN_DHCP_CLIENT_STATE_t;

#define OPEN_DHCP_CLIENTID_MAX  (128)             
#define OPEN_DHCP_VENDOR_CLASS_STRING_MAX  (128)  
/*************************************************************************/
open_error_t openapiDhcpVendorClassOptionAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiDhcpVendorClassOptionAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode, OPEN_BOOL_t actImmediate);

/*************************************************************************/
open_error_t openapiDhcpVendorClassOptionStringGet(openapiClientHandle_t *client_handle, open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiDhcpVendorClassOptionStringSet(openapiClientHandle_t *client_handle, open_buffdesc *bufd, OPEN_BOOL_t actImmediate);

/*************************************************************************/
open_error_t openapiIpDhcpClientDhcpServerIntfIPAddressGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, uint32_t *serverAddr);

/*************************************************************************/
open_error_t openapiIpDhcpClientIntfStateGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, OPEN_DHCP_CLIENT_STATE_t *clientState);

/*************************************************************************/
open_error_t openapiIpDhcpClientTransactionIntfIdGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, uint32_t *transId);

/*************************************************************************/
open_error_t openapiIpDhcpClientLeaseTimeIntfInfoGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, uint32_t *leaseTime, uint32_t *renewalTime, uint32_t *rebindTime);

/*************************************************************************/
open_error_t openapiIpDhcpClientIntfRetryCountGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, uint32_t *retryCount);

/*************************************************************************/
open_error_t openapiIpDhcpClientIdGeneratedGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_MGMT_PORT_TYPE_t mgmtPortType, open_buffdesc *clientId);

/*************************************************************************/
open_error_t openapiDhcpClientStatsGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *numDiscoverSent, uint32_t *numOfferRecvd, uint32_t *numRequestSent, uint32_t *numAckRecvd, uint32_t *numNackRecvd, uint32_t *numReleaseSent, uint32_t *numInformSent, uint32_t *numRebindSent, uint32_t *numRenewSent);

/*************************************************************************/
open_error_t openapiDhcpClientStatsClear(openapiClientHandle_t *client_handle, uint32_t ifNum);

#endif /* OPENAPI_IP4DHCPCLIENT_H_INCLUDED */