Return to vici_query.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libcharon / plugins / vici

Annotation of embedaddon/strongswan/src/libcharon/plugins/vici/vici_query.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2014 Martin Willi
                      3:  * Copyright (C) 2014 revosec AG
                      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:  * Copyright (C) 2014 Timo Teräs <timo.teras@iki.fi>
                     18:  *
                     19:  * Permission is hereby granted, free of charge, to any person obtaining a copy
                     20:  * of this software and associated documentation files (the "Software"), to deal
                     21:  * in the Software without restriction, including without limitation the rights
                     22:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
                     23:  * copies of the Software, and to permit persons to whom the Software is
                     24:  * furnished to do so, subject to the following conditions:
                     25:  *
                     26:  * The above copyright notice and this permission notice shall be included in
                     27:  * all copies or substantial portions of the Software.
                     28:  *
                     29:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
                     30:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
                     31:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
                     32:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
                     33:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
                     34:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
                     35:  * THE SOFTWARE.
                     36:  */
                     37: 
                     38: /**
                     39:  * @defgroup vici_query vici_query
                     40:  * @{ @ingroup vici
                     41:  */
                     42: 
                     43: #include <bus/listeners/listener.h>
                     44: #include "vici_dispatcher.h"
                     45: 
                     46: #ifndef VICI_QUERY_H_
                     47: #define VICI_QUERY_H_
                     48: 
                     49: typedef struct vici_query_t vici_query_t;
                     50: 
                     51: /**
                     52:  * Query helper, provides various commands to query/list daemon info.
                     53:  */
                     54: struct vici_query_t {
                     55: 
                     56:        /**
                     57:         * Implements listener_t.
                     58:         */
                     59:        listener_t listener;
                     60: 
                     61:        /**
                     62:         * Destroy a vici_query_t.
                     63:         */
                     64:        void (*destroy)(vici_query_t *this);
                     65: };
                     66: 
                     67: /**
                     68:  * Create a vici_query instance.
                     69:  *
                     70:  * @param dispatcher           dispatcher to receive requests from
                     71:  * @return                                     query handler
                     72:  */
                     73: vici_query_t *vici_query_create(vici_dispatcher_t *dispatcher);
                     74: 
                     75: #endif /** VICI_QUERY_H_ @}*/