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

1.1     ! misho       1: /*
        !             2:  * Copyright (C) 2012 Martin Willi
        !             3:  * Copyright (C) 2012 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:  * @defgroup dpd_timeout_job dpd_timeout_job
        !            18:  * @{ @ingroup cjobs
        !            19:  */
        !            20: 
        !            21: #ifndef DPD_TIMEOUT_JOB_H_
        !            22: #define DPD_TIMEOUT_JOB_H_
        !            23: 
        !            24: typedef struct dpd_timeout_job_t dpd_timeout_job_t;
        !            25: 
        !            26: #include <library.h>
        !            27: #include <processing/jobs/job.h>
        !            28: #include <sa/ike_sa_id.h>
        !            29: 
        !            30: /**
        !            31:  * Job enforcing DPD timeout.
        !            32:  *
        !            33:  * This job detects if a DPD response has been received during the DPD timeout
        !            34:  * interval, and if not, enforced the DPD action.
        !            35:  */
        !            36: struct dpd_timeout_job_t {
        !            37: 
        !            38:        /**
        !            39:         * implements job_t interface
        !            40:         */
        !            41:        job_t job_interface;
        !            42: };
        !            43: 
        !            44: /**
        !            45:  * Creates a DPD timeout job.
        !            46:  *
        !            47:  * @param ike_sa_id            ike_sa_id_t, gets cloned
        !            48:  * @return                             initiate_ike_sa_job_t object
        !            49:  */
        !            50: dpd_timeout_job_t *dpd_timeout_job_create(ike_sa_id_t *ike_sa_id);
        !            51: 
        !            52: #endif /** DPD_TIMEOUT_JOB_H_ @}*/

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