NetworkManager/libnm-core/nm-setting-macvlan.h
Beniamino Galvani f1d23c32c3 docs: libnm: add doc comment to types
This is required to add objects in the "Types and Values" section and
in the API index. Later, we may want to add useful content in those
empty comments.
2016-05-05 17:01:57 +02:00

98 lines
3.5 KiB
C

/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
/*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301 USA.
*
* Copyright 2015 Red Hat, Inc.
*/
#ifndef __NM_SETTING_MACVLAN_H__
#define __NM_SETTING_MACVLAN_H__
#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined (NETWORKMANAGER_COMPILATION)
#error "Only <NetworkManager.h> can be included directly."
#endif
#include "nm-setting.h"
G_BEGIN_DECLS
#define NM_TYPE_SETTING_MACVLAN (nm_setting_macvlan_get_type ())
#define NM_SETTING_MACVLAN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_MACVLAN, NMSettingMacvlan))
#define NM_SETTING_MACVLAN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_SETTING_MACVLANCONFIG, NMSettingMacvlanClass))
#define NM_IS_SETTING_MACVLAN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_SETTING_MACVLAN))
#define NM_IS_SETTING_MACVLAN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_SETTING_MACVLAN))
#define NM_SETTING_MACVLAN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_SETTING_MACVLAN, NMSettingMacvlanClass))
#define NM_SETTING_MACVLAN_SETTING_NAME "macvlan"
#define NM_SETTING_MACVLAN_PARENT "parent"
#define NM_SETTING_MACVLAN_MODE "mode"
#define NM_SETTING_MACVLAN_PROMISCUOUS "promiscuous"
#define NM_SETTING_MACVLAN_TAP "tap"
/**
* NMSettingMacvlan:
*/
struct _NMSettingMacvlan {
NMSetting parent;
};
typedef struct {
NMSettingClass parent;
/*< private >*/
gpointer padding[4];
} NMSettingMacvlanClass;
/**
* NMSettingMacvlanMode:
* @NM_SETTING_MACVLAN_MODE_UNKNOWN: unknown/unset mode
* @NM_SETTING_MACVLAN_MODE_VEPA: Virtual Ethernet Port Aggregator mode
* @NM_SETTING_MACVLAN_MODE_BRIDGE: bridge mode
* @NM_SETTING_MACVLAN_MODE_PRIVATE: private mode
* @NM_SETTING_MACVLAN_MODE_PASSTHRU: passthru mode
* @NM_SETTING_MACVLAN_MODE_SOURCE: source mode
**/
typedef enum {
NM_SETTING_MACVLAN_MODE_UNKNOWN = 0,
NM_SETTING_MACVLAN_MODE_VEPA = 1,
NM_SETTING_MACVLAN_MODE_BRIDGE = 2,
NM_SETTING_MACVLAN_MODE_PRIVATE = 3,
NM_SETTING_MACVLAN_MODE_PASSTHRU = 4,
NM_SETTING_MACVLAN_MODE_SOURCE = 5,
_NM_SETTING_MACVLAN_MODE_NUM, /*< skip >*/
NM_SETTING_MACVLAN_MODE_LAST = _NM_SETTING_MACVLAN_MODE_NUM - 1, /*< skip >*/
} NMSettingMacvlanMode;
NM_AVAILABLE_IN_1_2
GType nm_setting_macvlan_get_type (void);
NM_AVAILABLE_IN_1_2
NMSetting *nm_setting_macvlan_new (void);
NM_AVAILABLE_IN_1_2
const char *nm_setting_macvlan_get_parent (NMSettingMacvlan *setting);
NM_AVAILABLE_IN_1_2
NMSettingMacvlanMode nm_setting_macvlan_get_mode (NMSettingMacvlan *setting);
NM_AVAILABLE_IN_1_2
gboolean nm_setting_macvlan_get_promiscuous (NMSettingMacvlan *setting);
NM_AVAILABLE_IN_1_2
gboolean nm_setting_macvlan_get_tap (NMSettingMacvlan *setting);
G_END_DECLS
#endif /* __NM_SETTING_MACVLAN_H__ */