aboutsummaryrefslogtreecommitdiffstats
path: root/Source/charon/receiver.h
blob: b864556e86c4c44ffb73bb933b20a4b32c957aea (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
/**
 * @file receiver.h
 *
 * @brief Implements the Receiver Thread encapsulated in the receiver_t object
 *
 */

/*
 * Copyright (C) 2005 Jan Hutter, Martin Willi
 * 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.
 */

#ifndef RECEIVER_H_
#define RECEIVER_H_

#include "types.h"

/**
 * @brief A Receiver object which receives packets on the socket and adds them to the job-queue
 */
typedef struct receiver_s receiver_t;

struct receiver_s {

	/**
	 * @brief Destroys a receiver object
	 *
	 * @param receiver receiver object
	 * @return SUCCESSFUL if succeeded, FAILED otherwise
	 */
	status_t (*destroy) (receiver_t *receiver);
};


receiver_t * receiver_create();

#endif /*RECEIVER_H_*/