summaryrefslogtreecommitdiff
path: root/src/settings/plugins/example/common.h
blob: ed0be9a7f7a4f87211a571a4d527d95fbc5f261f (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
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/* NetworkManager system settings service
 *
 * 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.
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * (C) Copyright 2012 Red Hat, Inc.
 */

#ifndef __COMMON_H__
#define __COMMON_H__

#include <glib.h>

#include <nm-connection.h>

/* General info about the plugin that the code may want to use for logging
 * purposes.
 */
#define EXAMPLE_PLUGIN_NAME "example"
#define EXAMPLE_PLUGIN_INFO "(c) 2012 Red Hat, Inc.  To report bugs please use the NetworkManager mailing list."

#define EXAMPLE_DIR NMCONFDIR "/example-plugin"

/* Boilerplate stuff for the plugin's error domain.  Bits of the code that
 * create new errors in the plugin's domain will create errors of
 * type EXAMPLE_PLUGIN_ERROR like so:
 *
 *  error = g_error_new_literal (EXAMPLE_PLUGIN_ERROR,
 *                               <specific error number>,
 *                               "This is a really bad error.");
 */
#define EXAMPLE_PLUGIN_ERROR (example_plugin_error_quark ())
GQuark example_plugin_error_quark (void);

/* Prototypes for the reader/writer functions */
NMConnection *connection_from_file (const char *filename, GError **error);

gboolean write_connection (NMConnection *connection,
                           const char *existing_path,
                           char **out_path,
                           GError **error);

#endif  /* __COMMON_H__ */