Return to delete_ike_sa_job.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libcharon / processing / jobs

Annotation of embedaddon/strongswan/src/libcharon/processing/jobs/delete_ike_sa_job.h, revision 1.1

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2005-2006 Martin Willi
        !             3:  * Copyright (C) 2005 Jan Hutter
        !             4:  * HSR Hochschule fuer Technik Rapperswil
        !             5:  *
        !             6:  * This program is free software; you can redistribute it and/or modify it
        !             7:  * under the terms of the GNU General Public License as published by the
        !             8:  * Free Software Foundation; either version 2 of the License, or (at your
        !             9:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
        !            10:  *
        !            11:  * This program is distributed in the hope that it will be useful, but
        !            12:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
        !            13:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
        !            14:  * for more details.
        !            15:  */
        !            16: 
        !            17: /**
        !            18:  * @defgroup delete_child_sa_job delete_child_sa_job
        !            19:  * @{ @ingroup cjobs
        !            20:  */
        !            21: 
        !            22: #ifndef DELETE_IKE_SA_JOB_H_
        !            23: #define DELETE_IKE_SA_JOB_H_
        !            24: 
        !            25: typedef struct delete_ike_sa_job_t delete_ike_sa_job_t;
        !            26: 
        !            27: #include <library.h>
        !            28: #include <sa/ike_sa_id.h>
        !            29: #include <processing/jobs/job.h>
        !            30: 
        !            31: 
        !            32: /**
        !            33:  * Class representing an DELETE_IKE_SA Job.
        !            34:  *
        !            35:  * This job is responsible for deleting established or half open IKE_SAs.
        !            36:  * A half open IKE_SA is every IKE_SA which hasn't reached the SA_ESTABLISHED
        !            37:  * state.
        !            38:  */
        !            39: struct delete_ike_sa_job_t {
        !            40: 
        !            41:        /**
        !            42:         * The job_t interface.
        !            43:         */
        !            44:        job_t job_interface;
        !            45: };
        !            46: 
        !            47: /**
        !            48:  * Creates a job of type DELETE_IKE_SA.
        !            49:  *
        !            50:  * @param ike_sa_id                            id of the IKE_SA to delete
        !            51:  * @param delete_if_established        should the IKE_SA be deleted if it is established?
        !            52:  * @return                                             created delete_ike_sa_job_t object
        !            53:  */
        !            54: delete_ike_sa_job_t *delete_ike_sa_job_create(ike_sa_id_t *ike_sa_id,
        !            55:                                                                                          bool delete_if_established);
        !            56: 
        !            57: #endif /** DELETE_IKE_SA_JOB_H_ @}*/