Return to imv_reason_string.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libimcv / imv

Annotation of embedaddon/strongswan/src/libimcv/imv/imv_reason_string.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2012 Andreas Steffen
        !             3:  * HSR Hochschule fuer Technik Rapperswil
        !             4:  *
        !             5:  * This program is free software; you can redistribute it and/or modify it
        !             6:  * under the terms of the GNU General Public License as published by the
        !             7:  * Free Software Foundation; either version 2 of the License, or (at your
        !             8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
        !             9:  *
        !            10:  * This program is distributed in the hope that it will be useful, but
        !            11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
        !            12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        !            13:  * for more details.
        !            14:  */
        !            15: 
        !            16: /**
        !            17:  *
        !            18:  * @defgroup imv_reason_string_t imv_reason_string
        !            19:  * @{ @ingroup libimcv_imv
        !            20:  */
        !            21: 
        !            22: #ifndef IMV_REASON_STRING_H_
        !            23: #define IMV_REASON_STRING_H_
        !            24: 
        !            25: #include "imv_lang_string.h"
        !            26: 
        !            27: #include <library.h>
        !            28: #include <collections/linked_list.h>
        !            29: 
        !            30: typedef struct imv_reason_string_t imv_reason_string_t;
        !            31: 
        !            32: /**
        !            33:  * Defines and builds a TNC Reason String
        !            34:  */
        !            35: struct imv_reason_string_t {
        !            36: 
        !            37:        /**
        !            38:         * Add an individual remediation instruction to the string
        !            39:         *
        !            40:         * @param reason                Multi-lingual reason string
        !            41:         */
        !            42:         void (*add_reason)(imv_reason_string_t *this, imv_lang_string_t reason[]);
        !            43: 
        !            44:        /**
        !            45:         * Gets  encoding of the reason string
        !            46:         *
        !            47:         * @return                              TNC reason string
        !            48:         */
        !            49:        chunk_t (*get_encoding)(imv_reason_string_t *this);
        !            50: 
        !            51:        /**
        !            52:         * Destroys an imv_reason_string_t object
        !            53:         */
        !            54:        void (*destroy)(imv_reason_string_t *this);
        !            55: };
        !            56: 
        !            57: /**
        !            58:  * Creates an Reason String object
        !            59:  *
        !            60:  * @param lang                         Preferred language
        !            61:  * @param separator                    String separating multiple reasons
        !            62:  */
        !            63:  imv_reason_string_t* imv_reason_string_create(char *lang, char *separator);
        !            64: 
        !            65: #endif /** IMV_REASON_STRING_H_ @}*/