Return to retransmit_job.h CVS log

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

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

1.1       misho       1: /*
                      2:  * Copyright (C) 2005-2007 Martin Willi
                      3:  * Copyright (C) 2005 Jan Hutter
                      4:  * HSR Hochschule fuer Technik Rapperswil
                      5:  *
                      6:  * This program is free software; you can redistribute it and/or modify it
                      7:  * under the terms of the GNU General Public License as published by the
                      8:  * Free Software Foundation; either version 2 of the License, or (at your
                      9:  * option) any later version.  See <http://www.fsf.org/copyleft/gpl.txt>.
                     10:  *
                     11:  * This program is distributed in the hope that it will be useful, but
                     12:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
                     13:  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
                     14:  * for more details.
                     15:  */
                     16: 
                     17: /**
                     18:  * @defgroup retransmit_job retransmit_job
                     19:  * @{ @ingroup cjobs
                     20:  */
                     21: 
                     22: #ifndef RETRANSMIT_JOB_H_
                     23: #define RETRANSMIT_JOB_H_
                     24: 
                     25: typedef struct retransmit_job_t retransmit_job_t;
                     26: 
                     27: #include <library.h>
                     28: #include <processing/jobs/job.h>
                     29: #include <sa/ike_sa_id.h>
                     30: 
                     31: /**
                     32:  * Class representing an retransmit Job.
                     33:  *
                     34:  * This job is scheduled every time a request is sent over the
                     35:  * wire. If the response to the request is not received at schedule
                     36:  * time, the retransmission will be initiated.
                     37:  */
                     38: struct retransmit_job_t {
                     39:        /**
                     40:         * The job_t interface.
                     41:         */
                     42:        job_t job_interface;
                     43: };
                     44: 
                     45: /**
                     46:  * Creates a job of type retransmit.
                     47:  *
                     48:  * @param message_id           message_id of the request to resend
                     49:  * @param ike_sa_id                    identification of the ike_sa as ike_sa_id_t
                     50:  * @return                                     retransmit_job_t object
                     51:  */
                     52: retransmit_job_t *retransmit_job_create(uint32_t message_id,
                     53:                                                                                ike_sa_id_t *ike_sa_id);
                     54: 
                     55: #endif /** RETRANSMIT_JOB_H_ @}*/