aboutsummaryrefslogtreecommitdiffstats
path: root/src/libcharon/plugins/error_notify/error_notify_socket.h
blob: cb35b55844680ec642a2ed721ce12becb5f5e705 (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
/*
 * Copyright (C) 2012 Martin Willi
 * Copyright (C) 2012 revosec AG
 *
 * 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 error_notify_socket error_notify_socket
 * @{ @ingroup error_notify
 */

#ifndef ERROR_NOTIFY_SOCKET_H_
#define ERROR_NOTIFY_SOCKET_H_

typedef struct error_notify_socket_t error_notify_socket_t;

#include "error_notify_listener.h"
#include "error_notify_msg.h"

/**
 * Error notification socket.
 */
struct error_notify_socket_t {

	/**
	 * Send an error notification message to all registered listeners.
	 *
	 * @param msg		msg to send
	 */
	void (*notify)(error_notify_socket_t *this, error_notify_msg_t *msg);

	/**
	 * Check if we have active listeners on the socket.
	 *
	 * @return			TRUE if listeners active
	 */
	bool (*has_listeners)(error_notify_socket_t *this);

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

/**
 * Create a error_notify_socket instance.
 */
error_notify_socket_t *error_notify_socket_create();

#endif /** ERROR_NOTIFY_SOCKET_H_ @}*/