include/provider.h

/*
 *
 *  Connection Manager
 *
 *  Copyright (C) 2007-2010  Intel Corporation. All rights reserved.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef __CONNMAN_PROVIDER_H
#define __CONNMAN_PROVIDER_H

#include <connman/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * SECTION:provider
 * @title: Provider premitives
 * @short_description: Functions for handling providers
 */

enum connman_provider_type {
	CONNMAN_PROVIDER_TYPE_UNKNOWN = 0,
	CONNMAN_PROVIDER_TYPE_VPN     = 1,
};

enum connman_provider_state {
	CONNMAN_PROVIDER_STATE_UNKNOWN       = 0,
	CONNMAN_PROVIDER_STATE_IDLE          = 1,
	CONNMAN_PROVIDER_STATE_CONNECT       = 2,
	CONNMAN_PROVIDER_STATE_READY         = 3,
	CONNMAN_PROVIDER_STATE_DISCONNECT    = 4,
	CONNMAN_PROVIDER_STATE_FAILURE       = 5,
};

enum connman_provider_error {
	CONNMAN_PROVIDER_ERROR_NO_ERROR                = 0,
	CONNMAN_PROVIDER_ERROR_PIN_MISSING             = 1,
	CONNMAN_PROVIDER_ERROR_CONNECT_FAILED          = 2,
	CONNMAN_PROVIDER_ERROR_BAD_PASSPHRASE          = 3,
	CONNMAN_PROVIDER_ERROR_RESOLVE_HOSTNAME_FAILED = 4,
	CONNMAN_PROVIDER_ERROR_IPSEC_PSK_AUTH_FAILED   = 5,
	CONNMAN_PROVIDER_ERROR_IPSEC_CERT_AUTH_FAILED  = 6,
	CONNMAN_PROVIDER_ERROR_PPP_AUTH_FAILED         = 7,
	CONNMAN_PROVIDER_ERROR_INTERNAL                = 8,

	CONNMAN_PROVIDER_ERROR_MAX
};

#define	CONNMAN_PROVIDER_NAME	"Provider.Name"
#define	CONNMAN_PROVIDER_HOST	"Provider.Host"
#define	CONNMAN_PROVIDER_TYPE	"Provider.Type"
#define	CONNMAN_VPN_DOMAIN	"VPN.Domain"

struct connman_provider;

struct connman_provider *connman_provider_ref(struct connman_provider *provider);
void connman_provider_unref(struct connman_provider *provider);

const char *connman_provider_get_ident(struct connman_provider *provider);
connman_bool_t connman_provider_property_is_empty(
    struct connman_provider *provider, const char *property);
void connman_provider_append_properties(struct connman_provider *provider,
    const char *props[], DBusMessageIter *iter);
void connman_provider_load_save_properties(
    struct connman_provider *provider,
    const char *props[],
    void (*cb)(struct connman_provider *, const char *, GKeyFile *),
    GKeyFile *keyfile);
void connman_provider_save_property(struct connman_provider *provider,
					const char *key, GKeyFile *keyfile);
void connman_provider_save_encrypted_property(struct connman_provider *provider,
					const char *key, GKeyFile *keyfile);
void connman_provider_load_property(struct connman_provider *provider,
					const char *key, GKeyFile *keyfile);
void connman_provider_load_encrypted_property(struct connman_provider *provider,
					const char *key, GKeyFile *keyfile);
gboolean connman_provider_clear_property(struct connman_provider *provider,
							const char *key);
int connman_provider_set_string(struct connman_provider *provider,
					const char *key, const char *value);
const char *connman_provider_get_string(struct connman_provider *provider,
							const char *key);

int connman_provider_set_state(struct connman_provider *provider,
					enum connman_provider_state state);
int connman_provider_indicate_error(struct connman_provider *provider,
					enum connman_provider_error error);

void connman_provider_set_index(struct connman_provider *provider, int index);
int connman_provider_get_index(struct connman_provider *provider);

void connman_provider_set_interface(struct connman_provider *provider,
					const char *interface);
const char *connman_provider_get_interface(struct connman_provider *provider);

void connman_provider_set_data(struct connman_provider *provider, void *data);
void *connman_provider_get_data(struct connman_provider *provider);

typedef void (*provider_agent_cb_t)(struct connman_provider *provider,
					void *user_data, int);
int connman_provider_request_input(struct connman_provider *provider,
					provider_agent_cb_t cb, void *arg, ...);

struct connman_ipaddress;
void connman_provider_ipconfig_set(struct connman_provider *,
					const struct connman_ipaddress *);
void connman_provider_ipconfig_clear(struct connman_provider *provider);
void connman_provider_ipconfig_bind(struct connman_provider *provider);
int connman_provider_append_route(struct connman_provider *provider,
					const char *host, const char *netmask,
					const char *gateway);

const char *connman_provider_get_driver_name(struct connman_provider *provider);

struct connman_provider_driver {
	const char *name;
	enum connman_provider_type type;
	int (*probe) (struct connman_provider *provider);
	int (*remove) (struct connman_provider *provider);
	int (*connect) (struct connman_provider *provider);
	int (*disconnect) (struct connman_provider *provider);
	void (*append_props) (struct connman_provider *, DBusMessageIter *,
	    connman_bool_t isprivileged);
	void (*save_props) (struct connman_provider *, GKeyFile *);
	void (*load_props) (struct connman_provider *, GKeyFile *);
};

int connman_provider_driver_register(struct connman_provider_driver *driver);
void connman_provider_driver_unregister(struct connman_provider_driver *driver);

#ifdef __cplusplus
}
#endif

#endif /* __CONNMAN_PROVIDER_H */