src/charon/processing/jobs/send_dpd_job.h

   1 /**
   2  * @file send_dpd_job.h
   3  *
   4  * @brief Interface of send_dpd_job_t.
   5  */
   6
   7 /*
   8  * Copyright (C) 2006 Tobias Brunner, Daniel Roethlisberger
   9  * Hochschule fuer Technik Rapperswil
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation; either version 2 of the License, or (at your
  14  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  18  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19  * for more details.
  20  */
  21
  22 #ifndef SEND_DPD_JOB_H_
  23 #define SEND_DPD_JOB_H_
  24
  25 typedef struct send_dpd_job_t send_dpd_job_t;
  26
  27 #include <library.h>
  28 #include <processing/jobs/job.h>
  29 #include <sa/ike_sa_id.h>
  30
  31 /**
  32  * @brief Class representing a SEND_DPD Job.
  33  *
  34  * Job to periodically send a Dead Peer Detection (DPD) request,
  35  * ie. an IKE request with no payloads other than the encrypted payload
  36  * required by the syntax.
  37  *
  38  * @b Constructors:
  39  * - send_dpd_job_create()
  40  *
  41  * @ingroup jobs
  42  */
  43 struct send_dpd_job_t {
  44         /**
  45          * implements job_t interface
  46          */
  47         job_t job_interface;
  48
  49         /**
  50          * @brief Destroys an send_dpd_job_t object.
  51          *
  52          * @param this  send_dpd_job_t object to destroy
  53          */
  54         void (*destroy) (send_dpd_job_t *this);
  55 };
  56
  57 /**
  58  * @brief Creates a job of type SEND_DPD.
  59  *
  60  * @param ike_sa_id             identification of the ike_sa as ike_sa_id_t object (gets cloned)
  61  * @return                              initiate_ike_sa_job_t object
  62  *
  63  * @ingroup jobs
  64  */
  65 send_dpd_job_t *send_dpd_job_create(ike_sa_id_t *ike_sa_id);
  66
  67 #endif /*SEND_DPD_JOB_H_*/