Annotation of embedaddon/strongswan/src/libcharon/sa/ikev2/tasks/child_delete.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2007 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 child_delete child_delete
        !            18:  * @{ @ingroup tasks_v2
        !            19:  */
        !            20: 
        !            21: #ifndef CHILD_DELETE_H_
        !            22: #define CHILD_DELETE_H_
        !            23: 
        !            24: typedef struct child_delete_t child_delete_t;
        !            25: 
        !            26: #include <library.h>
        !            27: #include <sa/ike_sa.h>
        !            28: #include <sa/task.h>
        !            29: #include <sa/child_sa.h>
        !            30: 
        !            31: /**
        !            32:  * Task of type child_delete, delete a CHILD_SA.
        !            33:  */
        !            34: struct child_delete_t {
        !            35: 
        !            36:        /**
        !            37:         * Implements the task_t interface
        !            38:         */
        !            39:        task_t task;
        !            40: 
        !            41:        /**
        !            42:         * Get the CHILD_SA to delete by this task.
        !            43:         *
        !            44:         * @return                      child_sa
        !            45:         */
        !            46:        child_sa_t* (*get_child) (child_delete_t *this);
        !            47: };
        !            48: 
        !            49: /**
        !            50:  * Create a new child_delete task.
        !            51:  *
        !            52:  * @param ike_sa               IKE_SA this task works for
        !            53:  * @param protocol             protocol of CHILD_SA to delete, PROTO_NONE as responder
        !            54:  * @param spi                  inbound SPI of CHILD_SA to delete
        !            55:  * @param expired              TRUE if CHILD_SA already expired
        !            56:  * @return                             child_delete task to handle by the task_manager
        !            57:  */
        !            58: child_delete_t *child_delete_create(ike_sa_t *ike_sa, protocol_id_t protocol,
        !            59:                                                                        uint32_t spi, bool expired);
        !            60: 
        !            61: #endif /** CHILD_DELETE_H_ @}*/

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