/*
 * Copyright (C) 2011-2014 Andreas Steffen
 *
 * Copyright (C) secunet Security Networks AG
 *
 * This program 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 2 of the License, or (at your
 * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
 *
 * This program 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.
 */

/**
 *
 * @defgroup imc_state_t imc_state
 * @{ @ingroup libimcv_imc
 */

#ifndef IMC_STATE_H_
#define IMC_STATE_H_

#include "seg/seg_contract_manager.h"

#include <tncif.h>
#include <tncifimv.h>
#include <tncifimc.h>

#include <library.h>

typedef struct imc_state_t imc_state_t;

/**
 * Internal state of an IMC connection instance
 */
struct imc_state_t {

	/**
	 * Get the TNCS connection ID attached to the state
	 *
	 * @return				TNCS connection ID of the state
	 */
	 TNC_ConnectionID (*get_connection_id)(imc_state_t *this);

	/**
	 * Checks if long message types are supported for this TNCCS connection
	 *
	 * @return				TRUE if set, FALSE otherwise
	 */
	bool (*has_long)(imc_state_t *this);

	/**
	 * Checks if the exclusive delivery is supported for this TNCCS connection
	 *
	 * @return				TRUE if set, FALSE otherwise
	 */
	bool (*has_excl)(imc_state_t *this);

	/**
	 * Sets the long message types and exclusive flags for this TNCCS connection
	 *
	 * @param has_long		TNCCS connection supports long message types
	 * @param has_excl		TNCCS connection supports exclusive delivery
	 * @return				TRUE if set, FALSE otherwise
	 */
	void (*set_flags)(imc_state_t *this, bool has_long, bool has_excl);

	/**
	 * Set the maximum size of a PA-TNC message for this TNCCS connection
	 *
	 * @param max_msg_len	maximum size of a PA-TNC message
	 */
	void (*set_max_msg_len)(imc_state_t *this, uint32_t max_msg_len);

	/**
	 * Get the maximum size of a PA-TNC message for this TNCCS connection
	 *
	 * @return				maximum size of a PA-TNC message
	 */
	uint32_t (*get_max_msg_len)(imc_state_t *this);

	/**
	 * Get attribute segmentation contracts associated with TNCCS Connection
	 *
	 * @return				contracts associated with TNCCS Connection
	 */
	seg_contract_manager_t* (*get_contracts)(imc_state_t *this);

	/**
	 * Change the connection state
	 *
	 * @param new_state		new connection state
	 * @return				old connection state
	 */
	TNC_ConnectionState (*change_state)(imc_state_t *this,
						 TNC_ConnectionState new_state);

	/**
	 * Set the Assessment/Evaluation Result
	 *
	 * @param id			IMC ID
	 * @param result		Assessment/Evaluation Result
	 */
	void (*set_result)(imc_state_t *this, TNC_IMCID id,
										  TNC_IMV_Evaluation_Result result);

	/**
	 * Get the Assessment/Evaluation Result
	 *
	 * @param id			IMC ID
	 * @param result		Assessment/Evaluation Result
	 * @return				TRUE if result is known
	 */
	bool (*get_result)(imc_state_t *this, TNC_IMCID id,
										  TNC_IMV_Evaluation_Result *result);

	/**
	 * Resets the state for a new measurement cycle triggered by a SRETRY batch
	 */
	void (*reset)(imc_state_t *this);

	/**
	 * Destroys an imc_state_t object
	 */
	void (*destroy)(imc_state_t *this);
};

#endif /** IMC_STATE_H_ @}*/
