strongswan/Source/charon/queues/jobs/delete_half_open_ike_sa_job.h

76 lines
2.0 KiB
C

/**
* @file delete_half_open_ike_sa_job.h
*
* @brief Interface of delete_half_open_ike_sa_job_t.
*
*/
/*
* Copyright (C) 2005 Jan Hutter, Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*/
#ifndef DELETE_HALF_OPEN_IKE_SA_JOB_H_
#define DELETE_HALF_OPEN_IKE_SA_JOB_H_
#include <types.h>
#include <sa/ike_sa_id.h>
#include <queues/jobs/job.h>
typedef struct delete_half_open_ike_sa_job_t delete_half_open_ike_sa_job_t;
/**
* @brief Class representing an DELETE_HALF_OPEN_IKE_SA Job.
*
* @b Constructors:
* - delete_half_open_ike_sa_job_create()
*
* @ingroup jobs
*/
struct delete_half_open_ike_sa_job_t {
/**
* The job_t interface.
*/
job_t job_interface;
/**
* @brief Returns the currently set ike_sa_id.
*
* @warning Returned object is not copied.
*
* @param this calling delete_half_open_ike_sa_job_t object
* @return ike_sa_id_t object
*/
ike_sa_id_t * (*get_ike_sa_id) (delete_half_open_ike_sa_job_t *this);
/**
* @brief Destroys an delete_half_open_ike_sa_job_t object (including assigned data).
*
* @param this delete_half_open_ike_sa_job_t object to destroy
*/
void (*destroy) (delete_half_open_ike_sa_job_t *this);
};
/**
* @brief Creates a job of type DELETE_HALF_OPEN_IKE_SA.
*
* @param ike_sa_id id of the IKE_SA to delete
* @return created delete_half_open_ike_sa_job_t object
*
* @ingroup jobs
*/
delete_half_open_ike_sa_job_t *delete_half_open_ike_sa_job_create(ike_sa_id_t *ike_sa_id);
#endif /*DELETE_HALF_OPEN_IKE_SA_JOB_H_*/