summaryrefslogtreecommitdiff
path: root/src/libtls/tls_application.h
blob: 0debe9cee1b05f722a8036f0537bf245f0b111c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
/*
 * Copyright (C) 2010 Andreas Steffen
 * HSR 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.
 */

/**
 * @defgroup tls_handshake tls_handshake
 * @{ @ingroup libtls
 */

#ifndef TLS_APPLICATION_H_
#define TLS_APPLICATION_H_

typedef struct tls_application_t tls_application_t;

#include <bio/bio_reader.h>
#include <bio/bio_writer.h>

/**
 * TLS application data interface.
 */
struct tls_application_t {

	/**
	 * Process received TLS application data.
	 *
	 * @param reader	TLS data buffer
	 * @return
	 *					- SUCCESS if application completed
	 *					- FAILED if application data processing failed
	 *					- NEED_MORE if another invocation of process/build needed
	 */
	status_t (*process)(tls_application_t *this, bio_reader_t *reader);

	/**
	 * Build TLS application data to send out.
	 *
	 * @param writer	TLS data buffer to write to
	 * @return
	 *					- SUCCESS if application completed
	 *					- FAILED if application data build failed
	 *					- NEED_MORE if more data ready for delivery
	 *					- INVALID_STATE if more input to process() required
	 */
	status_t (*build)(tls_application_t *this, bio_writer_t *writer);

	/**
	 * Destroy a tls_application_t.
	 */
	void (*destroy)(tls_application_t *this);
};

#endif /** TLS_APPLICATION_H_ @}*/