mirror of
https://github.com/strongswan/strongswan.git
synced 2025-10-08 00:02:03 -04:00
153 lines
3.6 KiB
C
153 lines
3.6 KiB
C
/**
|
|
* @file job_queue.h
|
|
*
|
|
* @brief Job-Queue based on linked_list_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 JOB_QUEUE_H_
|
|
#define JOB_QUEUE_H_
|
|
|
|
#include "linked_list.h"
|
|
|
|
/**
|
|
* Type of Jobs in Job-Queue
|
|
*/
|
|
typedef enum job_type_e job_type_t;
|
|
|
|
enum job_type_e{
|
|
/**
|
|
* process an incoming IKEv2-Message
|
|
*/
|
|
INCOMING_PACKET,
|
|
/**
|
|
* retransmit an IKEv2-Message
|
|
*/
|
|
RETRANSMIT_REQUEST,
|
|
/**
|
|
* establish an ike sa as initiator
|
|
*/
|
|
ESTABLISH_IKE_SA
|
|
/* more job types have to be inserted here */
|
|
};
|
|
|
|
|
|
/**
|
|
* @brief Job as it is stored in the job queue
|
|
*
|
|
* A job consists of a job-type and an assigned value
|
|
*
|
|
* The value-type for a specific job is not discussed here
|
|
*/
|
|
typedef struct job_s job_t;
|
|
|
|
struct job_s{
|
|
/**
|
|
* Type of job
|
|
*/
|
|
job_type_t type;
|
|
/**
|
|
* Every job has its assigned_data based on the job type
|
|
*/
|
|
void * assigned_data;
|
|
|
|
/**
|
|
* @brief Destroys a job_t object
|
|
*
|
|
* @param job_t calling object
|
|
* @returns SUCCESS if succeeded, FAILED otherwise
|
|
*/
|
|
status_t (*destroy) (job_t *job);
|
|
};
|
|
|
|
/**
|
|
* @brief Creates a job of specific type
|
|
*
|
|
* @param type type of the job
|
|
* @param assigned_data value to assign to the job
|
|
*
|
|
* @return job_t job object
|
|
*/
|
|
job_t *job_create(job_type_t type, void *assigned_data);
|
|
|
|
/**
|
|
* @brief Job-Queue
|
|
*
|
|
* Despite the job-queue is based on a linked_list_t
|
|
* all access functions are thread-save implemented
|
|
*/
|
|
typedef struct job_queue_s job_queue_t;
|
|
|
|
struct job_queue_s {
|
|
|
|
/**
|
|
* @brief returns number of jobs in queue
|
|
*
|
|
* @param job_queue_t calling object
|
|
* @param[out] count integer pointer to store the job count in
|
|
* @returns SUCCESS if succeeded, FAILED otherwise
|
|
*/
|
|
status_t (*get_count) (job_queue_t *job_queue, int *count);
|
|
|
|
/**
|
|
* @brief get the next job from the queue
|
|
*
|
|
* If the queue is empty, this function blocks until a job can be returned.
|
|
*
|
|
* After using, the returned job has to get destroyed by the caller.
|
|
*
|
|
* @param job_queue_t calling object
|
|
* @param[out] job pointer to a job pointer where to job is returned to
|
|
* @returns SUCCESS if succeeded, FAILED otherwise
|
|
*/
|
|
status_t (*get) (job_queue_t *job_queue, job_t **job);
|
|
|
|
/**
|
|
* @brief adds a job to the queue
|
|
*
|
|
* This function is non blocking and adds a job_t to the list.
|
|
* The specific job-object has to get destroyed by the thread which
|
|
* removes the job.
|
|
*
|
|
* @param job_queue_t calling object
|
|
* @param[in] job job to add to the queue (job is not copied)
|
|
* @returns SUCCESS if succeeded, FAILED otherwise
|
|
*/
|
|
status_t (*add) (job_queue_t *job_queue, job_t *job);
|
|
|
|
/**
|
|
* @brief destroys a job_queue object
|
|
*
|
|
* @warning The caller of this function has to make sure
|
|
* that no thread is going to add or get a job from the job_queue
|
|
* after calling this function.
|
|
*
|
|
* @param job_queue_t calling object
|
|
* @returns SUCCESS if succeeded, FAILED otherwise
|
|
*/
|
|
status_t (*destroy) (job_queue_t *job_queue);
|
|
};
|
|
|
|
/**
|
|
* @brief Creates an empty job_queue
|
|
*
|
|
* @return job_queue_t empty job_queue
|
|
*/
|
|
job_queue_t *job_queue_create();
|
|
#endif /*JOB_QUEUE_H_*/
|