2005-11-07 07:33:31 +00:00
|
|
|
/**
|
|
|
|
* @file job.h
|
|
|
|
*
|
2005-11-29 08:08:03 +00:00
|
|
|
* @brief Interface job_t.
|
2005-11-07 07:33:31 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* 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 JOB_H_
|
|
|
|
#define JOB_H_
|
|
|
|
|
2005-11-23 09:13:40 +00:00
|
|
|
#include <types.h>
|
|
|
|
#include <definitions.h>
|
2005-11-07 07:33:31 +00:00
|
|
|
|
2005-11-24 09:17:51 +00:00
|
|
|
|
|
|
|
typedef enum job_type_t job_type_t;
|
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
/**
|
2005-11-29 08:08:03 +00:00
|
|
|
* @brief Definition of the various job types.
|
|
|
|
*
|
|
|
|
* @ingroup jobs
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
2005-11-24 09:17:51 +00:00
|
|
|
enum job_type_t {
|
2005-11-07 07:33:31 +00:00
|
|
|
/**
|
2005-11-16 14:43:13 +00:00
|
|
|
* Process an incoming IKEv2-Message
|
|
|
|
*
|
|
|
|
* Job is implemented in class type incoming_packet_job_t
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
|
|
|
INCOMING_PACKET,
|
|
|
|
/**
|
2005-11-16 14:43:13 +00:00
|
|
|
* Retransmit an IKEv2-Message
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
|
|
|
RETRANSMIT_REQUEST,
|
|
|
|
/**
|
2005-11-16 14:43:13 +00:00
|
|
|
* Establish an ike sa as initiator
|
|
|
|
*
|
|
|
|
* Job is implemented in class type initiate_ike_sa_job_t
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
2005-11-17 14:25:46 +00:00
|
|
|
INITIATE_IKE_SA,
|
|
|
|
/**
|
|
|
|
* Delete an ike sa
|
|
|
|
*
|
|
|
|
* Job is implemented in class type delete_ike_sa_job_t
|
|
|
|
*/
|
|
|
|
DELETE_IKE_SA
|
|
|
|
|
2005-11-16 14:43:13 +00:00
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
/* more job types have to be inserted here */
|
|
|
|
};
|
|
|
|
|
2005-11-29 08:08:03 +00:00
|
|
|
/**
|
|
|
|
* string mappings for job_type_t
|
|
|
|
*/
|
2005-11-16 12:31:28 +00:00
|
|
|
extern mapping_t job_type_m[];
|
2005-11-07 07:33:31 +00:00
|
|
|
|
2005-11-24 09:17:51 +00:00
|
|
|
|
|
|
|
typedef struct job_t job_t;
|
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
/**
|
2005-11-29 08:08:03 +00:00
|
|
|
* @brief Job-Interface as it is stored in the job queue.
|
|
|
|
*
|
|
|
|
* A job consists of a job-type and one or more assigned values.
|
2005-11-07 07:33:31 +00:00
|
|
|
*
|
2005-11-29 08:08:03 +00:00
|
|
|
* @ingroup jobs
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
2005-11-29 08:08:03 +00:00
|
|
|
struct job_t {
|
2005-11-16 14:43:13 +00:00
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
/**
|
2005-11-29 08:08:03 +00:00
|
|
|
* @brief get type of job.
|
2005-11-16 14:43:13 +00:00
|
|
|
*
|
|
|
|
* @param this calling object
|
|
|
|
* @return type of this job
|
2005-11-07 07:33:31 +00:00
|
|
|
*/
|
2005-11-16 14:43:13 +00:00
|
|
|
job_type_t (*get_type) (job_t *this);
|
2005-11-07 07:33:31 +00:00
|
|
|
|
2005-11-17 12:49:56 +00:00
|
|
|
/**
|
|
|
|
* @brief Destroys a job_t object and all assigned data!
|
|
|
|
*
|
|
|
|
* @param job_t calling object
|
|
|
|
*/
|
2005-11-29 08:08:03 +00:00
|
|
|
void (*destroy_all) (job_t *job);
|
2005-11-17 12:49:56 +00:00
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
/**
|
|
|
|
* @brief Destroys a job_t object
|
|
|
|
*
|
|
|
|
* @param job_t calling object
|
|
|
|
*/
|
2005-11-29 08:08:03 +00:00
|
|
|
void (*destroy) (job_t *job);
|
2005-11-07 07:33:31 +00:00
|
|
|
};
|
|
|
|
|
2005-11-17 14:25:46 +00:00
|
|
|
|
2005-11-07 07:33:31 +00:00
|
|
|
#endif /*JOB_H_*/
|