Return to send_dpd_job.h CVS log

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

Annotation of embedaddon/strongswan/src/libcharon/processing/jobs/send_dpd_job.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
                      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 send_dpd_job send_dpd_job
                     18:  * @{ @ingroup cjobs
                     19:  */
                     20: 
                     21: #ifndef SEND_DPD_JOB_H_
                     22: #define SEND_DPD_JOB_H_
                     23: 
                     24: typedef struct send_dpd_job_t send_dpd_job_t;
                     25: 
                     26: #include <library.h>
                     27: #include <processing/jobs/job.h>
                     28: #include <sa/ike_sa_id.h>
                     29: 
                     30: /**
                     31:  * Class representing a SEND_DPD Job.
                     32:  *
                     33:  * Job to periodically send a Dead Peer Detection (DPD) request,
                     34:  * ie. an IKE request with no payloads other than the encrypted payload
                     35:  * required by the syntax.
                     36:  */
                     37: struct send_dpd_job_t {
                     38:        /**
                     39:         * implements job_t interface
                     40:         */
                     41:        job_t job_interface;
                     42: };
                     43: 
                     44: /**
                     45:  * Creates a job of type SEND_DPD.
                     46:  *
                     47:  * @param ike_sa_id            identification of the ike_sa as ike_sa_id_t object (gets cloned)
                     48:  * @return                             initiate_ike_sa_job_t object
                     49:  */
                     50: send_dpd_job_t *send_dpd_job_create(ike_sa_id_t *ike_sa_id);
                     51: 
                     52: #endif /** SEND_DPD_JOB_H_ @}*/