Return to initiate_mediation_job.h CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / strongswan / src / libcharon / processing / jobs

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

1.1       misho       1: /*
                      2:  * Copyright (C) 2007-2008 Tobias Brunner
                      3:  * HSR Hochschule fuer Technik Rapperswil
                      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_mediation_job initiate_mediation_job
                     18:  * @{ @ingroup cjobs
                     19:  */
                     20: 
                     21: #ifndef INITIATE_MEDIATION_JOB_H_
                     22: #define INITIATE_MEDIATION_JOB_H_
                     23: 
                     24: typedef struct initiate_mediation_job_t initiate_mediation_job_t;
                     25: 
                     26: #include <processing/jobs/job.h>
                     27: #include <sa/ike_sa_id.h>
                     28: 
                     29: /**
                     30:  * Class representing a INITIATE_MEDIATION Job.
                     31:  *
                     32:  * This job will initiate a mediation on behalf of a mediated connection.
                     33:  * If required the mediation connection is established.
                     34:  */
                     35: struct initiate_mediation_job_t {
                     36:        /**
                     37:         * implements job_t interface
                     38:         */
                     39:        job_t job_interface;
                     40: };
                     41: 
                     42: /**
                     43:  * Creates a job of type INITIATE_MEDIATION.
                     44:  *
                     45:  * @param ike_sa_id            identification of the ike_sa as ike_sa_id_t object (gets cloned)
                     46:  * @return                             job object
                     47:  */
                     48: initiate_mediation_job_t *initiate_mediation_job_create(ike_sa_id_t *ike_sa_id);
                     49: 
                     50: /**
                     51:  * Creates a special job of type INITIATE_MEDIATION that reinitiates a
                     52:  * specific connection.
                     53:  *
                     54:  * @param mediation_sa_id              identification of the mediation sa (gets cloned)
                     55:  * @param mediated_sa_id               identification of the mediated sa (gets cloned)
                     56:  * @return                                             job object
                     57:  */
                     58: initiate_mediation_job_t *reinitiate_mediation_job_create(
                     59:                                                                                                ike_sa_id_t *mediation_sa_id,
                     60:                                                                                                ike_sa_id_t *mediated_sa_id);
                     61: 
                     62: #endif /** INITIATE_MEDIATION_JOB_H_ @}*/