/*
 * Copyright (C) 2017, 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 tmsrp_header.h
  * @brief Defines a MSRP header/line (<type>=<value>).
  *
  * @author Mamadou Diop <diopmamadou(at)doubango.org>
  *
 
  */
 #ifndef TINYMSRP_HEADER_H
 #define TINYMSRP_HEADER_H
 
 #include "tinymsrp_config.h"
 
 #include "tsk_ragel_state.h"
 #include "tsk_list.h"
 
 TMSRP_BEGIN_DECLS
 
 struct tmsrp_header_s;
 
 #define TMSRP_HEADER(self)					((tmsrp_header_t*)(self))
 #define TMSRP_HEADER_VALUE_TOSTRING_F(self)	((tmsrp_header_value_tostring_f)(self))
 
 typedef int (*tmsrp_header_value_tostring_f)(const struct tmsrp_header_s* header, tsk_buffer_t* output);
 
 /**
  * @enum	tmsrp_header_type_e
  *
  * @brief	List of all supported headers.
 **/
 typedef enum tmsrp_header_type_e
 {
 	tmsrp_htype_Authentication_Info,
 	tmsrp_htype_Authorization,
 	tmsrp_htype_Byte_Range,
 	tmsrp_htype_Content_Type,
 	tmsrp_htype_Dummy,
 	tmsrp_htype_Expires,
 	tmsrp_htype_Failure_Report,
 	tmsrp_htype_From_Path,
 	tmsrp_htype_Max_Expires,
 	tmsrp_htype_Message_ID,
 	tmsrp_htype_Min_Expires,
 	tmsrp_htype_Status,
 	tmsrp_htype_Success_Report,
 	tmsrp_htype_To_Path,
 	tmsrp_htype_Use_Path,
 	tmsrp_htype_WWW_Authenticate
 }
 tmsrp_header_type_t;
 
 /*================================
 */
 typedef struct tmsrp_header_s
 {
 	TSK_DECLARE_OBJECT;
 	tmsrp_header_type_t type;
 	tmsrp_header_value_tostring_f tostring;
 }
 tmsrp_header_t;
 
 #define TMSRP_DECLARE_HEADER tmsrp_header_t __header__
 typedef tsk_list_t tmsrp_headers_L_t; /**< List of @ref tmsrp_header_t elements. */
 /*
 ================================*/
 
 TINYMSRP_API const char* tmsrp_header_get_name(tmsrp_header_type_t type);
 TINYMSRP_API const char* tmsrp_header_get_nameex(const tmsrp_header_t *self);
 TINYMSRP_API int tmsrp_header_serialize(const tmsrp_header_t *self, tsk_buffer_t *output);
 TINYMSRP_API char* tmsrp_header_tostring(const tmsrp_header_t *self);
 
 TMSRP_END_DECLS
 
 #endif /* TINYMSRP_HEADER_H */