dp_backend.h revision 50c2a57dea6d38a4f6753a917a5d745b07036325
/*
SSSD
Data Provider, private header file
Copyright (C) Simo Sorce <ssorce@redhat.com> 2008
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
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.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __DP_BACKEND_H__
#define __DP_BACKEND_H__
#include "providers/data_provider.h"
#include "providers/fail_over.h"
#include "providers/be_refresh.h"
#include "util/child_common.h"
/* a special token, if used in place of the hostname, denotes that real
* hostnames should be looked up from DNS using SRV requests
*/
#define BE_SRV_IDENTIFIER "_srv_"
struct be_ctx;
struct bet_ops;
struct be_req;
typedef void (*be_shutdown_fn)(void *);
typedef void (*be_req_fn_t)(struct be_req *);
typedef void (*be_async_callback_t)(struct be_req *, int, int, const char *);
typedef void (*be_callback_t)(void *);
enum bet_type {
BET_NULL = 0,
};
struct bet_data {
const char *option_name;
const char *mod_init_fn_name_fmt;
};
struct loaded_be {
char *be_name;
void *handle;
};
struct bet_info {
void *pvt_bet_data;
char *mod_name;
struct bet_queue_item *req_queue;
};
struct be_offline_status {
bool offline;
};
struct be_resolv_ctx {
struct resolv_ctx *resolv;
enum restrict_family family_order;
};
struct be_client {
struct sbus_connection *conn;
struct tevent_timer *timeout;
bool initialized;
};
struct be_failover_ctx;
struct be_cb;
struct be_ctx {
struct tevent_context *ev;
struct confdb_ctx *cdb;
struct sss_domain_info *domain;
const char *identity;
const char *conf_path;
struct be_failover_ctx *be_fo;
struct be_resolv_ctx *be_res;
/* Functions to be invoked when the
* backend goes online or offline
*/
struct be_cb *online_cb_list;
bool run_online_cb;
struct be_cb *offline_cb_list;
struct be_cb *reconnect_cb_list;
/* In contrast to online_cb_list which are only run if the backend is
* offline the unconditional_online_cb_list should be run whenever the
* backend receives a request to go online. The typical use case is to
* reset timers independenly of the state of the backend. */
struct be_cb *unconditional_online_cb_list;
struct be_offline_status offstat;
/* Periodicly check if we can go online. */
struct be_ptask *check_if_online_ptask;
struct sbus_connection *mon_conn;
struct sbus_connection *sbus_srv;
struct be_client *autofs_cli;
struct be_refresh_ctx *refresh_ctx;
/* List of ongoing requests */
struct be_req *active_requests;
};
struct bet_ops {
};
struct be_acct_req {
int entry_type;
int attr_type;
int filter_type;
char *filter_value;
char *extra_value;
char *domain;
};
struct be_sudo_req {
char **rules;
};
struct be_autofs_req {
char *mapname;
bool invalidate;
};
struct be_subdom_req {
bool force;
char *domain_hint;
};
struct be_host_req {
int filter_type;
char *name;
char *alias;
};
void *pvt,
struct be_cb **reconnect_cb);
void *pvt,
struct be_cb **unconditional_online_cb);
void *pvt,
/* from data_provider_fo.c */
enum be_fo_protocol {
};
typedef void (be_svc_callback_fn_t)(void *, struct fo_server *);
int be_fo_is_srv_identifier(const char *server);
void *pvt,
const char *plugin_name);
const char *hostname);
const char *service_name,
const char *query_service,
const char *default_discovery_domain,
enum be_fo_protocol proto,
bool proto_fallback, void *user_data);
bool primary);
struct tevent_context *ev,
const char *service_name,
bool first_try);
const char *service_name,
enum port_status status,
int line,
const char *file,
const char *function);
/*
* Instruct fail-over to try next server on the next connect attempt.
* Should be used after connection to service was unexpectedly dropped
* but there is no authoritative information on whether active server is down.
*/
const char *service_name);
const char *service_name);
/* be_req helpers */
/* Create a back end request and call fn when done. Please note the
* request name is not duplicated. The caller should either provide
* a static string or steal a dynamic string onto req context.
*/
const char *name,
void *pvt_fn_data);
const char *domain);
/* Request account information */
struct tevent_req *
struct tevent_context *ev,
struct be_acct_req *ar);
int *_err_maj,
int *_err_min,
const char **_err_msg);
#endif /* __DP_BACKEND_H___ */