Annotation of embedaddon/strongswan/src/libcharon/processing/jobs/initiate_tasks_job.h, revision 1.1.1.1

1.1       misho       1: /*
                      2:  * Copyright (C) 2015 Martin Willi
                      3:  * Copyright (C) 2015 revosec AG
                      4:  *
                      5:  * This program is free software; you can redistribute it and/or modify it
                      6:  * under the terms of the GNU General Public License as published by the
                      7:  * Free Software Foundation; either version 2 of the License, or (at your
                      8:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
                      9:  *
                     10:  * This program is distributed in the hope that it will be useful, but
                     11:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
                     12:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
                     13:  * for more details.
                     14:  */
                     15: 
                     16: /**
                     17:  * @defgroup initiate_tasks_job initiate_tasks_job
                     18:  * @{ @ingroup cjobs
                     19:  */
                     20: 
                     21: #ifndef INITIATE_TASKS_JOB_H_
                     22: #define INITIATE_TASKS_JOB_H_
                     23: 
                     24: typedef struct initiate_tasks_job_t initiate_tasks_job_t;
                     25: 
                     26: #include <library.h>
                     27: #include <processing/jobs/job.h>
                     28: #include <sa/ike_sa_id.h>
                     29: 
                     30: /**
                     31:  * Job triggering initiation of any queued IKE_SA tasks.
                     32:  */
                     33: struct initiate_tasks_job_t {
                     34: 
                     35:        /**
                     36:         * Implements job_t interface
                     37:         */
                     38:        job_t job_interface;
                     39: };
                     40: 
                     41: /**
                     42:  * Creates a job to trigger IKE_SA task initiation.
                     43:  *
                     44:  * @param ike_sa_id            ID of IKE_SA to trigger tasks for (gets cloned)
                     45:  * @return                             job instance
                     46:  */
                     47: initiate_tasks_job_t *initiate_tasks_job_create(ike_sa_id_t *ike_sa_id);
                     48: 
                     49: #endif /** INITIATE_TASKS_JOB_H_ @}*/

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>