libnm: mark NMTeamLinkWatcher arguments as const in API

NMTeamLinkWatcher is immutable, meaning there is no way to change an
existing instance (aside increasing/decreasing the ref-count).

Hence, all API is implicitly const.

Still, mark the arguments as const.
This commit is contained in:
Thomas Haller 2019-05-11 10:24:15 +02:00
parent 35c92cf582
commit e28bd1289b
4 changed files with 35 additions and 33 deletions

View file

@ -38,7 +38,7 @@
**/
/*****************************************************************************
* NMTeamLinkWatch
* NMTeamLinkWatcher
*****************************************************************************/
G_DEFINE_BOXED_TYPE (NMTeamLinkWatcher, nm_team_link_watcher,
@ -378,7 +378,8 @@ nm_team_link_watcher_unref (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
gboolean
nm_team_link_watcher_equal (NMTeamLinkWatcher *watcher, NMTeamLinkWatcher *other)
nm_team_link_watcher_equal (const NMTeamLinkWatcher *watcher,
const NMTeamLinkWatcher *other)
{
_CHECK_WATCHER (watcher, FALSE);
_CHECK_WATCHER (other, FALSE);
@ -435,7 +436,7 @@ _nm_team_link_watchers_equal (GPtrArray *a, GPtrArray *b, gboolean ignore_order)
* Since: 1.12
**/
NMTeamLinkWatcher *
nm_team_link_watcher_dup (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_dup (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, NULL);
@ -476,7 +477,7 @@ nm_team_link_watcher_dup (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
const char *
nm_team_link_watcher_get_name (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_name (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, NULL);
@ -493,7 +494,7 @@ nm_team_link_watcher_get_name (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
int
nm_team_link_watcher_get_delay_up (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_delay_up (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);
@ -512,7 +513,7 @@ nm_team_link_watcher_get_delay_up (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
int
nm_team_link_watcher_get_delay_down (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_delay_down (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);
@ -531,7 +532,7 @@ nm_team_link_watcher_get_delay_down (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
int
nm_team_link_watcher_get_init_wait (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_init_wait (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);
@ -552,7 +553,7 @@ nm_team_link_watcher_get_init_wait (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
int
nm_team_link_watcher_get_interval (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_interval (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);
@ -572,7 +573,7 @@ nm_team_link_watcher_get_interval (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
int
nm_team_link_watcher_get_missed_max (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_missed_max (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);
@ -592,7 +593,7 @@ nm_team_link_watcher_get_missed_max (NMTeamLinkWatcher *watcher)
* Since: 1.16
**/
int
nm_team_link_watcher_get_vlanid (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_vlanid (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, -1);
@ -611,7 +612,7 @@ nm_team_link_watcher_get_vlanid (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
const char *
nm_team_link_watcher_get_target_host (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_target_host (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, NULL);
@ -627,7 +628,7 @@ nm_team_link_watcher_get_target_host (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
const char *
nm_team_link_watcher_get_source_host (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_source_host (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, NULL);
@ -643,7 +644,7 @@ nm_team_link_watcher_get_source_host (NMTeamLinkWatcher *watcher)
* Since: 1.12
**/
NMTeamLinkWatcherArpPingFlags
nm_team_link_watcher_get_flags (NMTeamLinkWatcher *watcher)
nm_team_link_watcher_get_flags (const NMTeamLinkWatcher *watcher)
{
_CHECK_WATCHER (watcher, 0);

View file

@ -88,29 +88,30 @@ void nm_team_link_watcher_ref (NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
void nm_team_link_watcher_unref (NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
gboolean nm_team_link_watcher_equal (NMTeamLinkWatcher *watcher, NMTeamLinkWatcher *other);
gboolean nm_team_link_watcher_equal (const NMTeamLinkWatcher *watcher,
const NMTeamLinkWatcher *other);
NM_AVAILABLE_IN_1_12
NMTeamLinkWatcher *nm_team_link_watcher_dup (NMTeamLinkWatcher *watcher);
NMTeamLinkWatcher *nm_team_link_watcher_dup (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
const char *nm_team_link_watcher_get_name (NMTeamLinkWatcher *watcher);
const char *nm_team_link_watcher_get_name (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
int nm_team_link_watcher_get_delay_up (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_delay_up (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
int nm_team_link_watcher_get_delay_down (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_delay_down (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
int nm_team_link_watcher_get_init_wait (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_init_wait (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
int nm_team_link_watcher_get_interval (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_interval (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
int nm_team_link_watcher_get_missed_max (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_missed_max (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
const char *nm_team_link_watcher_get_target_host (NMTeamLinkWatcher *watcher);
const char *nm_team_link_watcher_get_target_host (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
const char *nm_team_link_watcher_get_source_host (NMTeamLinkWatcher *watcher);
const char *nm_team_link_watcher_get_source_host (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_12
NMTeamLinkWatcherArpPingFlags nm_team_link_watcher_get_flags (NMTeamLinkWatcher *watcher);
NMTeamLinkWatcherArpPingFlags nm_team_link_watcher_get_flags (const NMTeamLinkWatcher *watcher);
NM_AVAILABLE_IN_1_16
int nm_team_link_watcher_get_vlanid (NMTeamLinkWatcher *watcher);
int nm_team_link_watcher_get_vlanid (const NMTeamLinkWatcher *watcher);
#define NM_TYPE_SETTING_TEAM (nm_setting_team_get_type ())
#define NM_SETTING_TEAM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_SETTING_TEAM, NMSettingTeam))

View file

@ -45,9 +45,9 @@ typedef struct {
NMTeamLinkWatcherType watcher_type;
KeyType key_type;
union {
int (*fint) (NMTeamLinkWatcher *watcher);
gboolean (*fbool) (NMTeamLinkWatcher *watcher);
const char *(*fstring) (NMTeamLinkWatcher *watcher);
int (*fint) (const NMTeamLinkWatcher *watcher);
gboolean (*fbool) (const NMTeamLinkWatcher *watcher);
const char *(*fstring) (const NMTeamLinkWatcher *watcher);
} get_fcn;
union {
int vint;
@ -56,19 +56,19 @@ typedef struct {
} TeamLinkWatcherKeyInfo;
static gboolean
_team_link_watcher_validate_active (NMTeamLinkWatcher *watcher)
_team_link_watcher_validate_active (const NMTeamLinkWatcher *watcher)
{
return NM_FLAGS_HAS (nm_team_link_watcher_get_flags (watcher), NM_TEAM_LINK_WATCHER_ARP_PING_FLAG_VALIDATE_ACTIVE);
}
static gboolean
_team_link_watcher_validate_inactive (NMTeamLinkWatcher *watcher)
_team_link_watcher_validate_inactive (const NMTeamLinkWatcher *watcher)
{
return NM_FLAGS_HAS (nm_team_link_watcher_get_flags (watcher), NM_TEAM_LINK_WATCHER_ARP_PING_FLAG_VALIDATE_INACTIVE);
}
static gboolean
_team_link_watcher_send_always (NMTeamLinkWatcher *watcher)
_team_link_watcher_send_always (const NMTeamLinkWatcher *watcher)
{
return NM_FLAGS_HAS (nm_team_link_watcher_get_flags (watcher), NM_TEAM_LINK_WATCHER_ARP_PING_FLAG_SEND_ALWAYS);
}
@ -142,7 +142,7 @@ _parse_data_get_bool (const ParseData parse_data[static _NM_TEAM_LINK_WATCHER_KE
}
char *
nm_utils_team_link_watcher_to_string (NMTeamLinkWatcher *watcher)
nm_utils_team_link_watcher_to_string (const NMTeamLinkWatcher *watcher)
{
nm_auto_free_gstring GString *str = NULL;
const char *name;

View file

@ -46,7 +46,7 @@ typedef enum {
_NM_TEAM_LINK_WATCHER_KEY_NUM,
} NMTeamLinkWatcherKeyId;
char *nm_utils_team_link_watcher_to_string (NMTeamLinkWatcher *watcher);
char *nm_utils_team_link_watcher_to_string (const NMTeamLinkWatcher *watcher);
NMTeamLinkWatcher *nm_utils_team_link_watcher_from_string (const char *str,
GError **error);