2007-04-11 13:01:08 +00:00
|
|
|
/**
|
2007-04-27 14:25:08 +00:00
|
|
|
* @file interface_manager.h
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
2007-04-27 14:25:08 +00:00
|
|
|
* @brief Interface of interface_manager_t.
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright (C) 2007 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.
|
|
|
|
*/
|
|
|
|
|
2007-04-27 14:25:08 +00:00
|
|
|
#ifndef INTERFACE_MANAGER_H_
|
|
|
|
#define INTERFACE_MANAGER_H_
|
2007-04-11 13:01:08 +00:00
|
|
|
|
2007-04-16 12:52:49 +00:00
|
|
|
#include <bus/bus.h>
|
|
|
|
|
|
|
|
/**
|
2007-04-30 10:23:01 +00:00
|
|
|
* callback to log things triggered by interface_manager.
|
2007-04-16 12:52:49 +00:00
|
|
|
*
|
|
|
|
* @param param echoed parameter supplied when function invoked
|
|
|
|
* @param signal type of signal
|
|
|
|
* @param level verbosity level if log
|
|
|
|
* @param ike_sa associated IKE_SA, if any
|
|
|
|
* @param format printf like format string
|
|
|
|
* @param args list of arguments to use for format
|
|
|
|
* @return FALSE to return from invoked function
|
|
|
|
* @ingroup control
|
|
|
|
*/
|
2007-04-27 14:25:08 +00:00
|
|
|
typedef bool(*interface_manager_cb_t)(void* param, signal_t signal, level_t level,
|
2007-04-16 12:52:49 +00:00
|
|
|
ike_sa_t* ike_sa, char* format, va_list args);
|
2007-04-11 13:01:08 +00:00
|
|
|
|
2007-04-27 14:25:08 +00:00
|
|
|
typedef struct interface_manager_t interface_manager_t;
|
2007-04-11 13:01:08 +00:00
|
|
|
|
|
|
|
/**
|
2007-04-30 10:23:01 +00:00
|
|
|
* @brief The interface_manager loads control interfaces and has helper methods.
|
2007-04-16 12:52:49 +00:00
|
|
|
*
|
2007-04-30 10:23:01 +00:00
|
|
|
* One job of the interface manager is to load pluggable control interface
|
|
|
|
* modules, implemented as interface_t.
|
|
|
|
* @verbatim
|
|
|
|
|
|
|
|
+---------+ +------------+ +--------------+ |
|
|
|
|
| | | |<----- +--------------+ | |
|
|
|
|
| daemon |<-----| interface- | +--------------+ |-+ <==|==> IPC
|
|
|
|
| core | | manager |<----| interfaces |-+ |
|
|
|
|
| |<-----| | +--------------+ |
|
|
|
|
| | | | |
|
|
|
|
+---------+ +------------+ |
|
|
|
|
|
|
|
|
@endverbatim
|
|
|
|
* The manager does not really use the interfaces, instead, the interface
|
|
|
|
* use the manager to fullfill their tasks (initiating, terminating, ...).
|
2007-04-27 14:25:08 +00:00
|
|
|
* The interface_manager starts actions by creating jobs. It then tries to
|
2007-04-16 12:52:49 +00:00
|
|
|
* evaluate the result of the operation by listening on the bus.
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
|
|
|
* @b Constructors:
|
2007-04-27 14:25:08 +00:00
|
|
|
* - interface_manager_create()
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
|
|
|
* @ingroup control
|
|
|
|
*/
|
2007-04-27 14:25:08 +00:00
|
|
|
struct interface_manager_t {
|
2007-04-16 12:52:49 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Initiate a CHILD_SA, and if required, an IKE_SA.
|
|
|
|
*
|
|
|
|
* @param this calling object
|
|
|
|
* @param peer_cfg peer_cfg to use for IKE_SA setup
|
|
|
|
* @param child_cfg child_cfg to set up CHILD_SA from
|
|
|
|
* @param cb logging callback
|
|
|
|
* @param param parameter to include in each call of cb
|
|
|
|
* @return
|
|
|
|
* - SUCCESS, if CHILD_SA established
|
|
|
|
* - FAILED, if setup failed
|
|
|
|
* - NEED_MORE, if callback returned FALSE
|
|
|
|
*/
|
2007-04-27 14:25:08 +00:00
|
|
|
status_t (*initiate)(interface_manager_t *this,
|
2007-04-16 12:52:49 +00:00
|
|
|
peer_cfg_t *peer_cfg, child_cfg_t *child_cfg,
|
2007-04-27 14:25:08 +00:00
|
|
|
interface_manager_cb_t callback, void *param);
|
2007-04-11 13:01:08 +00:00
|
|
|
|
|
|
|
/**
|
2007-04-27 14:25:08 +00:00
|
|
|
* @brief Destroy a interface_manager_t instance.
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
2007-04-27 14:25:08 +00:00
|
|
|
* @param this interface_manager_t objec to destroy
|
2007-04-11 13:01:08 +00:00
|
|
|
*/
|
2007-04-27 14:25:08 +00:00
|
|
|
void (*destroy) (interface_manager_t *this);
|
2007-04-11 13:01:08 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2007-04-30 10:23:01 +00:00
|
|
|
* @brief Creates a interface_manager instance and loads all interface modules.
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
2007-04-27 14:25:08 +00:00
|
|
|
* @return interface_manager_t object
|
2007-04-11 13:01:08 +00:00
|
|
|
*
|
|
|
|
* @ingroup control
|
|
|
|
*/
|
2007-04-27 14:25:08 +00:00
|
|
|
interface_manager_t *interface_manager_create(void);
|
|
|
|
|
|
|
|
#endif /* INTERFACE_MANAGER_H_ */
|
2007-04-11 13:01:08 +00:00
|
|
|
|