fnet_dhcp_cln.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  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.
*
***************************************************************************
*
*  FNET DHCPv4 Client API.
*
***************************************************************************/

#ifndef _FNET_DHCP_CLN_H_

#define _FNET_DHCP_CLN_H_

#if FNET_CFG_DHCP_CLN || defined(__DOXYGEN__)

/**************************************************************************/ 
#define FNET_DHCP_CLN_LEASE_INFINITY    (0xFFFFFFFFU)

/**************************************************************************/ 
#define FNET_DHCP_CLN_LEASE_MIN         (180U)

/**************************************************************************/ 
typedef struct
{
    fnet_netif_desc_t   netif;                  
    struct fnet_in_addr requested_ip_address;   
    fnet_uint32_t       requested_lease_time;   
    fnet_bool_t         probe_addr;             
} fnet_dhcp_cln_params_t;

/**************************************************************************/ 
struct fnet_dhcp_cln_options
{
    struct fnet_in_addr ip_address;  
    struct fnet_in_addr netmask;     
    struct fnet_in_addr gateway;     
    struct fnet_in_addr dhcp_server; 
#if FNET_CFG_DHCP_CLN_BROADCAST
    struct fnet_in_addr broadcast;   
#endif
#if FNET_CFG_DNS
    struct fnet_in_addr dns;         
#endif
    /* For debug needs: */
    fnet_uint32_t t1;           
    fnet_uint32_t t2;           
    fnet_uint32_t lease_time;   
};

#if defined(__cplusplus)
extern "C" {
#endif

/**************************************************************************/ 
typedef void *fnet_dhcp_cln_desc_t;

/***************************************************************************/ 
fnet_dhcp_cln_desc_t fnet_dhcp_cln_init( fnet_dhcp_cln_params_t *params );

/***************************************************************************/ 
void fnet_dhcp_cln_release(fnet_dhcp_cln_desc_t desc);

/***************************************************************************/ 
void fnet_dhcp_cln_get_options(fnet_dhcp_cln_desc_t desc, struct fnet_dhcp_cln_options *options );

/**************************************************************************/ 
typedef void(*fnet_dhcp_cln_callback_t)(fnet_dhcp_cln_desc_t desc, fnet_netif_desc_t netif, void *cookie);

/***************************************************************************/ 
void fnet_dhcp_cln_set_callback_updated (fnet_dhcp_cln_desc_t desc, fnet_dhcp_cln_callback_t callback_updated, void *cookie);

/***************************************************************************/ 
void fnet_dhcp_cln_set_callback_discover (fnet_dhcp_cln_desc_t desc, fnet_dhcp_cln_callback_t callback_discover, void *cookie);

/***************************************************************************/ 
void fnet_dhcp_cln_set_response_timeout(fnet_dhcp_cln_desc_t desc, fnet_time_t response_timout_ms);

/***************************************************************************/ 
fnet_bool_t fnet_dhcp_cln_is_enabled(fnet_dhcp_cln_desc_t desc);

/***************************************************************************/ 
fnet_dhcp_cln_desc_t fnet_dhcp_cln_get_by_netif(fnet_netif_desc_t netif);

#if defined(__cplusplus)
}
#endif

#endif /* FNET_CFG_DHCP_CLN */

#endif /* _FNET_DHCP_CLN_H_ */