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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
/*
* Copyright (C) 2013 Martin Willi
* Copyright (C) 2013 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 vici_dispatcher vici_dispatcher
* @{ @ingroup vici
*/
#ifndef VICI_DISPATCHER_H_
#define VICI_DISPATCHER_H_
#include "vici_message.h"
typedef struct vici_dispatcher_t vici_dispatcher_t;
typedef enum vici_operation_t vici_operation_t;
/**
* Default socket URI of vici service
*/
#ifdef WIN32
# define VICI_DEFAULT_URI "tcp://127.0.0.1:4502"
#else
# define VICI_DEFAULT_URI "unix://" IPSEC_PIDDIR "/charon.vici"
#endif
/**
* Kind of vici operation
*/
enum vici_operation_t {
/** a named request message */
VICI_CMD_REQUEST,
/** an unnamed response message to a request */
VICI_CMD_RESPONSE,
/** unnamed response if requested command is unknown */
VICI_CMD_UNKNOWN,
/** a named event registration request */
VICI_EVENT_REGISTER,
/** a named event unregistration request */
VICI_EVENT_UNREGISTER,
/** unnamed response for successful event (un-)registration */
VICI_EVENT_CONFIRM,
/** unnamed response if event (un-)registration failed */
VICI_EVENT_UNKNOWN,
/** a named event message */
VICI_EVENT,
};
/**
* Vici command callback function
*
* @param user user data, as supplied during registration
* @param name name of the command it has been registered under
* @param id client connection identifier
* @param request request message data
* @return response message
*/
typedef vici_message_t* (*vici_command_cb_t)(void *user, char *name, u_int id,
vici_message_t *request);
/**
* Vici command dispatcher.
*/
struct vici_dispatcher_t {
/**
* Register/Unregister a callback invoked for a specific command request.
*
* @param name name of the command
* @param cb callback function to register, NULL to unregister
* @param user user data to pass to callback
*/
void (*manage_command)(vici_dispatcher_t *this, char *name,
vici_command_cb_t cb, void *user);
/**
* Register/Unregister an event type to send.
*
* The dispatcher internally manages event subscriptions. Clients registered
* for an event will receive such messages when the event is raised.
*
* @param name event name to manager
* @param reg TRUE to register, FALSE to unregister
*/
void (*manage_event)(vici_dispatcher_t *this, char *name, bool reg);
/**
* Raise an event to a specific or all clients registered to that event.
*
* @param name event name to raise
* @param id client connection ID, 0 for all
* @param message event message to send, gets destroyed
*/
void (*raise_event)(vici_dispatcher_t *this, char *name, u_int id,
vici_message_t *message);
/**
* Destroy a vici_dispatcher_t.
*/
void (*destroy)(vici_dispatcher_t *this);
};
/**
* Create a vici_dispatcher instance.
*
* @param uri uri for listening stream service
* @return dispatcher instance
*/
vici_dispatcher_t *vici_dispatcher_create(char *uri);
#endif /** VICI_DISPATCHER_H_ @}*/
|
