eapol/eapol_framework/eapol_common/type/tls_peap/tls/include/tls_alert_message.h
changeset 0 c8830336c852
child 2 1c7bc153c08e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/eapol/eapol_framework/eapol_common/type/tls_peap/tls/include/tls_alert_message.h	Thu Dec 17 08:47:43 2009 +0200
@@ -0,0 +1,139 @@
+/*
+* Copyright (c) 2001-2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  EAP and WLAN authentication protocols.
+*
+*/
+
+
+
+
+#if !defined(_TLS_ALERT_MESSAGE_H_)
+#define _TLS_ALERT_MESSAGE_H_
+
+#include "eap_tools.h"
+#include "eap_array.h"
+#include "tls_peap_types.h"
+
+
+/** @file */
+
+
+/// This class defines one TLS alert message.
+/**
+ * This class defines TLS-Alert message.
+ */
+class EAP_EXPORT tls_alert_message_c
+{
+private:
+	//--------------------------------------------------
+
+	/// This is pointer to the tools class. @see abs_eap_am_tools_c.
+	abs_eap_am_tools_c * const m_am_tools;
+
+	/// This is buffer for geneated TLS-Alert message.
+	eap_variable_data_c m_tls_alert_message_buffer;
+
+	/// This is the alert level.
+	tls_alert_level_e m_alert_level;
+
+	/// This is the alert description.
+	tls_alert_description_e m_alert_description;
+
+	/// This indicates whether this object is client (true) or server (false). This mostly for traces.
+	bool m_is_client;
+
+	/// This indicates whether this object was generated successfully.
+	bool m_is_valid;
+
+	//--------------------------------------------------
+
+	/**
+	 * The set_is_valid() function sets the state of the object valid.
+	 * The creator of this object calls this function after it is initialized. 
+	 */
+	EAP_FUNC_IMPORT void set_is_valid();
+
+	//--------------------------------------------------
+protected:
+	//--------------------------------------------------
+
+	//--------------------------------------------------
+public:
+	//--------------------------------------------------
+
+	/// Destructor does nothing.
+	EAP_FUNC_IMPORT virtual ~tls_alert_message_c();
+
+	/// Constructor initializes the object.
+	EAP_FUNC_IMPORT tls_alert_message_c(
+		abs_eap_am_tools_c * const tools,
+		const bool is_client);
+
+
+	/**
+	 * Object must indicate it's validity.
+	 * If object initialization fails this function must return false.
+	 * @return This function returns the validity of this object.
+	 */
+	EAP_FUNC_IMPORT bool get_is_valid();
+
+
+	/**
+	 * This function creates data of the Handshake message to internal buffer.
+	 * Later this data is added to final TLS-record buffer.
+	 */
+	EAP_FUNC_IMPORT eap_status_e create_message_data();
+
+
+
+	/**
+	 * This function sets alert level.
+	 */
+	EAP_FUNC_IMPORT eap_status_e set_alert_level(const tls_alert_level_e alert_level);
+
+	/**
+	 * This function gets alert level.
+	 */
+	EAP_FUNC_IMPORT tls_alert_level_e get_alert_level() const;
+
+
+	/**
+	 * This function sets alert description.
+	 */
+	EAP_FUNC_IMPORT eap_status_e set_alert_description(const tls_alert_description_e alert_description);
+
+	/**
+	 * This function gets alert description.
+	 */
+	EAP_FUNC_IMPORT tls_alert_description_e get_alert_description() const;
+
+
+	/**
+	 * This function adds data of the TLS-Alert message to tls_message_buffer.
+	 */
+	EAP_FUNC_IMPORT eap_status_e add_message_data(
+		eap_variable_data_c * const tls_message_buffer);
+
+	// 
+	//--------------------------------------------------
+}; // class tls_alert_message_c
+
+
+//--------------------------------------------------
+
+#endif //#if !defined(_TLS_ALERT_MESSAGE_H_)
+
+
+
+// End.