Annotation of embedaddon/strongswan/src/libcharon/plugins/stroke/stroke_list.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2008 Martin Willi
                      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:  * @defgroup stroke_list stroke_list
                     18:  * @{ @ingroup stroke
                     19:  */
                     20: 
                     21: #ifndef STROKE_LIST_H_
                     22: #define STROKE_LIST_H_
                     23: 
                     24: #include "stroke_attribute.h"
                     25: 
                     26: #include <stroke_msg.h>
                     27: #include <library.h>
                     28: 
                     29: typedef struct stroke_list_t stroke_list_t;
                     30: 
                     31: /**
                     32:  * Log status information to stroke console
                     33:  */
                     34: struct stroke_list_t {
                     35: 
                     36:        /**
                     37:         * List certificate information to stroke console.
                     38:         *
                     39:         * @param msg           stroke message
                     40:         * @param out           stroke console stream
                     41:         */
                     42:        void (*list)(stroke_list_t *this, stroke_msg_t *msg, FILE *out);
                     43: 
                     44:        /**
                     45:         * Log status information to stroke console.
                     46:         *
                     47:         * @param msg           stroke message
                     48:         * @param out           stroke console stream
                     49:         * @param all           TRUE for "statusall"
                     50:         * @param wait          TRUE to wait for IKE_SA entries, FALSE to skip if locked
                     51:         */
                     52:        void (*status)(stroke_list_t *this, stroke_msg_t *msg, FILE *out,
                     53:                                   bool all, bool wait);
                     54: 
                     55:        /**
                     56:         * Log pool leases to stroke console.
                     57:         *
                     58:         * @param msg           stroke message
                     59:         * @param out           stroke console stream
                     60:         */
                     61:        void (*leases)(stroke_list_t *this, stroke_msg_t *msg, FILE *out);
                     62: 
                     63:        /**
                     64:         * Destroy a stroke_list instance.
                     65:         */
                     66:        void (*destroy)(stroke_list_t *this);
                     67: };
                     68: 
                     69: /**
                     70:  * Create a stroke_list instance.
                     71:  *
                     72:  * @param attribute            strokes attribute provider
                     73:  */
                     74: stroke_list_t *stroke_list_create(stroke_attribute_t *attribute);
                     75: 
                     76: #endif /** STROKE_LIST_H_ @}*/

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>