Files
strongswan-ext/Source/charon/jobs/delete_ike_sa_job.h
T

75 lines
1.8 KiB
C

/**
* @file delete_ike_sa_job.h
*
* @brief Job of type DELETE_IKE_SA
*
*/
/*
* 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_IKE_SA_JOB_H_
#define DELETE_IKE_SA_JOB_H_
#include "../types.h"
#include "../ike_sa_id.h"
#include "job.h"
/**
* Object representing an DELETE_IKE_SA Job
*
*/
typedef struct delete_ike_sa_job_s delete_ike_sa_job_t;
struct delete_ike_sa_job_s {
/**
* implements 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_ike_sa_job_t object
* @return ike_sa_id_t object
*/
ike_sa_id_t * (*get_ike_sa_id) (delete_ike_sa_job_t *this);
/**
* @brief Destroys an delete_ike_sa_job_t object (including assigned data)
*
* @param this delete_ike_sa_job_t object to destroy
* @return
* SUCCESS in any case
*/
status_t (*destroy) (delete_ike_sa_job_t *this);
};
/**
* Creates a job of type DELETE_IKE_SA
*
* @param ike_sa_id id of the IKE_SA to delete
* @return
* - delete_ike_sa_job_t if successfully
* - NULL if out of ressources
*/
delete_ike_sa_job_t *delete_ike_sa_job_create(ike_sa_id_t *ike_sa_id);
#endif /*DELETE_IKE_SA_JOB_H_*/