- increased generator buffer
[strongswan.git] / Source / charon / generator.h
1 /**
2 * @file generator.h
3 *
4 * @brief Generic generator class used to generate IKEv2-header and payloads.
5 *
6 */
7
8 /*
9 * Copyright (C) 2005 Jan Hutter, Martin Willi
10 * Hochschule fuer Technik Rapperswil
11 *
12 * This program is free software; you can redistribute it and/or modify it
13 * under the terms of the GNU General Public License as published by the
14 * Free Software Foundation; either version 2 of the License, or (at your
15 * option) any later version. See <http://www.fsf.org/copyleft/gpl.txt>.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
19 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
20 * for more details.
21 */
22
23 #ifndef GENERATOR_H_
24 #define GENERATOR_H_
25
26 #include "types.h"
27 #include "payloads/encodings.h"
28 #include "payloads/payload.h"
29
30 /**
31 * Generating is done in a data buffer.
32 * This is thehe start size of this buffer in Bytes.
33 */
34 #define GENERATOR_DATA_BUFFER_SIZE 500
35
36 /**
37 * Number of bytes to increase the buffer, if it is to small.
38 */
39 #define GENERATOR_DATA_BUFFER_INCREASE_VALUE 500
40
41 /**
42 *A generator_t object which generates payloads of specific type.
43 */
44 typedef struct generator_s generator_t;
45
46 struct generator_s {
47
48 /**
49 * @brief Generates a specific payload from given payload object.
50 *
51 * Remember: Header and substructures are also handled as payloads.
52 *
53 * @param this generator_t object
54 * @param[in] payload interface payload_t implementing object
55 * @return
56 * - SUCCESSFUL if succeeded
57 * - OUT_OF_RES if out of ressources
58 */
59 status_t (*generate_payload) (generator_t *this,payload_t *payload);
60
61 /**
62 * Writes all generated data of current generator context to a chunk
63 *
64 * @param this generator_t object
65 * * @param[out] data chunk to write the data to
66 * @return
67 * @return
68 * - SUCCESSFUL if succeeded
69 * - OUT_OF_RES otherwise
70 */
71 status_t (*write_to_chunk) (generator_t *this,chunk_t *data);
72
73 /**
74 * @brief Destroys a generator_t object.
75 *
76 * @param this generator_t object
77 *
78 * @return always success
79 */
80 status_t (*destroy) (generator_t *this);
81 };
82
83 /**
84 * Constructor to create a generator
85 *
86 */
87 generator_t * generator_create();
88
89 #endif /*GENERATOR_H_*/