/*

 * Copyright (C) 2020, University of the Basque Country (UPV/EHU)

 * Contact for licensing options: <licensing-mcpttclient(at)mcopenplatform(dot)com>
 *
 * The original file was part of Open Source Doubango Framework
 * Copyright (C) 2010-2011 Mamadou Diop.
 * Copyright (C) 2012 Doubango Telecom <http://doubango.org>
 *
 * This file is part of Open Source Doubango Framework.
 *
 * DOUBANGO is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * DOUBANGO is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with DOUBANGO.
 *
 */
 /**@file tnet_dhcp.h
  * @brief DHCP (RFC 2131 - Dynamic Host Configuration Protocol) utilities function for P-CSCF discovery(RFC 3319 and 3361)
  *		  Also implement: RFC 3315, 3118, 3319, 3825 (Geoconf), 4676 (Civic Addresses Configuration Information)...
  *
  * @author Mamadou Diop <diopmamadou(at)doubango[dot]org>
  *
 
  */
 
 #ifndef TNET_DHCP_H
 #define TNET_DHCP_H
 
 #include "tinynet_config.h"
 
 #include "tnet_dhcp_message.h"
 
 #include "tnet_utils.h"
 
 #include "tsk_object.h"
 #include "tsk_safeobj.h"
 
 TNET_BEGIN_DECLS
 
 /**@ingroup tnet_dhcp_group 
 * Default timeout (in milliseconds) value for DHCP requests. 
 */
 #define TNET_DHCP_TIMEOUT_DEFAULT				2000
 
 /**@ingroup tnet_dhcp_group
 * Local port(client) to bind to for incoming DHCP messages as per RFC 2131 subclause 4.1. */
 #define TNET_DHCP_CLIENT_PORT		68
 /**@ingroup tnet_dhcp_group
 * Destination port(Server) for outgoing DHCP messages as per RFC 2131 subclause 4.1. */
 #define TNET_DHCP_SERVER_PORT		67
 
 /**@ingroup tnet_dhcp_group
 * @def TNET_DHCP_VENDOR_ID_DEFAULT
 */
 /**@ingroup tnet_dhcp_group
 * @def TNET_DHCP_MAX_CODES
 */
 /**@ingroup tnet_dhcp_group
 * @def TNET_DHCP_MAX_MSG_SIZE
 */
 #define TNET_DHCP_VENDOR_ID_DEFAULT				"doubango/v0.0.0"
 #define TNET_DHCP_MAX_CODES						20
 #define TNET_DHCP_MAX_MSG_SIZE					1500
 
 /**@ingroup tnet_dhcp_group
 * Parameter Request List (55)
 */
 typedef struct tnet_dhcp_params_s
 {
 	TSK_DECLARE_OBJECT;
 
 	tnet_dhcp_option_code_t codes[TNET_DHCP_MAX_CODES];
 	unsigned codes_count;
 }
 tnet_dhcp_params_t;
 
 /**@ingroup tnet_dhcp_group
 */
 typedef struct tnet_dhcp_ctx_s
 {
 	TSK_DECLARE_OBJECT;
 	
 	char* vendor_id;
 	char* hostname;
 	uint16_t max_msg_size; /**< Option code 57. */
 
 	uint64_t timeout;
 
 	tnet_port_t port_client; /**< Local port to bind to for incloming DHCP messages. Default: 68 */
 	tnet_port_t server_port; /**< Destination port for outgoing DHCP messages. Default: 64 */
 	tnet_interfaces_L_t *interfaces;
 	
 	TSK_DECLARE_SAFEOBJ;
 }
 tnet_dhcp_ctx_t;
 
 
 TINYNET_API tnet_dhcp_reply_t* tnet_dhcp_query(tnet_dhcp_ctx_t* ctx, tnet_dhcp_message_type_t type, tnet_dhcp_params_t* params);
 #define tnet_dhcp_query_discover(ctx, params)	tnet_dhcp_query(ctx, dhcp_type_discover, params)
 #define tnet_dhcp_query_request(ctx, params)	tnet_dhcp_query(ctx, dhcp_type_request, params)
 #define tnet_dhcp_query_decline(ctx, params)	tnet_dhcp_query(ctx, dhcp_type_decline, params)
 #define tnet_dhcp_query_release(ctx, params)	tnet_dhcp_query(ctx, dhcp_type_release, params)
 #define tnet_dhcp_query_inform(ctx, params)	tnet_dhcp_query(ctx, dhcp_type_inform, params)
 
 TINYNET_API int tnet_dhcp_params_add_code(tnet_dhcp_params_t* params, tnet_dhcp_option_code_t code);
 
 
 TINYNET_API tnet_dhcp_ctx_t* tnet_dhcp_ctx_create();
 TINYNET_API tnet_dhcp_params_t* tnet_dhcp_params_create();
 
 TINYNET_GEXTERN const tsk_object_def_t *tnet_dhcp_ctx_def_t;
 TINYNET_GEXTERN const tsk_object_def_t *tnet_dhcp_params_def_t;
 
 TNET_END_DECLS
 
 #endif /* TNET_DHCP_H */