Embedded TCP/IP stack: fnet_dhcp_srv.h Source File

FNET

Embedded TCP/IP stack 4.1.0
 /**************************************************************************
 *
 * Copyright 2017 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 Server API.
 *
 ***************************************************************************/
 
 #ifndef _FNET_DHCP_SRV_H_
 
 #define _FNET_DHCP_SRV_H_
 
 #if FNET_CFG_DHCP_SRV || defined(__DOXYGEN__)
 
 /**************************************************************************/ 
 struct fnet_dhcp_srv_params
 {
  fnet_netif_desc_t netif; 
  fnet_ip4_addr_t ip_addr_pool_start; 
  fnet_size_t ip_addr_pool_size; 
  fnet_uint32_t lease_time; 
  fnet_ip4_addr_t subnet_mask; 
  fnet_ip4_addr_t gateway; 
 #if FNET_CFG_DNS
  fnet_ip4_addr_t dns; 
 #endif
 };
 
 /**************************************************************************/ 
 typedef struct
 {
  fnet_mac_addr_t client_mac_addr; 
  fnet_ip4_addr_t client_ip4_addr; 
  fnet_time_t lease_time; 
 } fnet_dhcp_srv_addr_pool_info_t;
 
 /**************************************************************************/ 
 typedef void* fnet_dhcp_srv_desc_t;
 
 #if defined(__cplusplus)
 extern "C" {
 #endif
 
 /***************************************************************************/ 
 fnet_dhcp_srv_desc_t fnet_dhcp_srv_init( struct fnet_dhcp_srv_params *params );
 
 /***************************************************************************/ 
 void fnet_dhcp_srv_release(fnet_dhcp_srv_desc_t desc);
 
 /***************************************************************************/ 
 fnet_bool_t fnet_dhcp_srv_get_addr_pool_info(fnet_dhcp_srv_desc_t desc, fnet_index_t n, fnet_dhcp_srv_addr_pool_info_t *addr_info);
 
 /***************************************************************************/ 
 fnet_bool_t fnet_dhcp_srv_is_enabled(fnet_dhcp_srv_desc_t desc);
 
 /***************************************************************************/ 
 fnet_dhcp_srv_desc_t fnet_dhcp_srv_get_by_netif(fnet_netif_desc_t netif);
 
 
 #if defined(__cplusplus)
 }
 #endif
 
 #endif /* FNET_CFG_DHCP_SRV */
 
 #endif /* _FNET_DHCP_SRV_H_ */
previous page start next page