NMSettingConnection

Properties

@@ -146,25 +146,8 @@ a Details

-
NMSettingConnection
-
typedef struct _NMSettingConnection NMSettingConnection;
-
-The NMSettingConnection struct contains only private data. -It should only be accessed through the functions described below. -
-
-
-
-
NMSettingConnectionClass
-
typedef struct { - NMSettingClass parent; - - /* Padding for future expansion */ - void (*_reserved1) (void); - void (*_reserved2) (void); - void (*_reserved3) (void); - void (*_reserved4) (void); -} NMSettingConnectionClass; +
NM_SETTING_CONNECTION_SETTING_NAME
+
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"

@@ -184,8 +167,11 @@ It should only be accessed through the functions described below. Describes errors that may result from operations involving a NMSettingConnection.
-
+
+++ @@ -222,19 +208,29 @@ Describes errors that may result from operations involving a
-
NM_SETTING_CONNECTION_AUTOCONNECT
-
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect" +
NM_SETTING_CONNECTION_ERROR
+
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark ()

-
NM_SETTING_CONNECTION_ERROR
-
#define NM_SETTING_CONNECTION_ERROR nm_setting_connection_error_quark () -
+
nm_setting_connection_error_quark ()
+
GQuark nm_setting_connection_error_quark (void);

+Registers an error quark for NMSettingConnection if necessary.
+

NM_SETTING_CONNECTION_ERROR_UNKNOWN

++++ + + + + +

Returns :
the error quark used for NMSettingConnection errors.

@@ -246,16 +242,32 @@ Describes errors that may result from operations involving a

-
NM_SETTING_CONNECTION_MASTER
-
#define NM_SETTING_CONNECTION_MASTER "master" +
NM_SETTING_CONNECTION_UUID
+
#define NM_SETTING_CONNECTION_UUID "uuid"

-
NM_SETTING_CONNECTION_PERMISSIONS
-
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions" +
NM_SETTING_CONNECTION_TYPE
+
#define NM_SETTING_CONNECTION_TYPE "type" +
+
+
+
+
+
+
NM_SETTING_CONNECTION_AUTOCONNECT
+
#define NM_SETTING_CONNECTION_AUTOCONNECT "autoconnect" +
+
+
+
+
+
+
NM_SETTING_CONNECTION_TIMESTAMP
+
#define NM_SETTING_CONNECTION_TIMESTAMP "timestamp"

@@ -270,114 +282,99 @@ Describes errors that may result from operations involving a

-
NM_SETTING_CONNECTION_SECONDARIES
-
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries" +
NM_SETTING_CONNECTION_PERMISSIONS
+
#define NM_SETTING_CONNECTION_PERMISSIONS "permissions"

-
NM_SETTING_CONNECTION_SETTING_NAME
-
#define NM_SETTING_CONNECTION_SETTING_NAME "connection" +
NM_SETTING_CONNECTION_ZONE
+
#define NM_SETTING_CONNECTION_ZONE "zone"

-
NM_SETTING_CONNECTION_SLAVE_TYPE
-
#define NM_SETTING_CONNECTION_SLAVE_TYPE "slave-type" +
NM_SETTING_CONNECTION_MASTER
+
#define NM_SETTING_CONNECTION_MASTER "master"

-
NM_SETTING_CONNECTION_TIMESTAMP
-
#define NM_SETTING_CONNECTION_TIMESTAMP "timestamp" +
NM_SETTING_CONNECTION_SLAVE_TYPE
+
#define NM_SETTING_CONNECTION_SLAVE_TYPE "slave-type"

-
NM_SETTING_CONNECTION_TYPE
-
#define NM_SETTING_CONNECTION_TYPE "type" +
NM_SETTING_CONNECTION_SECONDARIES
+
#define NM_SETTING_CONNECTION_SECONDARIES "secondaries"

-
NM_SETTING_CONNECTION_UUID
-
#define NM_SETTING_CONNECTION_UUID "uuid" -
+
NMSettingConnection
+
typedef struct _NMSettingConnection NMSettingConnection;

+The NMSettingConnection struct contains only private data. +It should only be accessed through the functions described below.

-
NM_SETTING_CONNECTION_ZONE
-
#define NM_SETTING_CONNECTION_ZONE "zone" +
NMSettingConnectionClass
+
typedef struct { + NMSettingClass parent; + + /* Padding for future expansion */ + void (*_reserved1) (void); + void (*_reserved2) (void); + void (*_reserved3) (void); + void (*_reserved4) (void); +} NMSettingConnectionClass;

-
nm_setting_connection_add_permission ()
-
gboolean nm_setting_connection_add_permission - (NMSettingConnection *setting, - const char *ptype, - const char *pitem, - const char *detail);
+
nm_setting_connection_new ()
+
NMSetting * nm_setting_connection_new (void);

-Adds a permission to the connection's permission list. At this time, only -the "user" permission type is supported, and pitem must be a username. See -"permissions": for more details. +Creates a new NMSettingConnection object with default values.
-
+
+- - - - - - - - - - - - - - - - - - ++ + - - - + +

setting :
the NMSettingConnection -
ptype :
the permission type; at this time only "user" is supported
pitem :
the permission item formatted as required for ptype -
detail :
unused at this time; must be NULL. [allow-none] -

Returns :
TRUE if the permission was unique and was successfully added to the -list, FALSE if ptype or pitem was invalid or it the permission was already -present in the list
the new empty NMSettingConnection object

-
nm_setting_connection_add_secondary ()
-
gboolean nm_setting_connection_add_secondary (NMSettingConnection *setting, - const char *sec_uuid);
+
nm_setting_connection_get_id ()
+
const char * nm_setting_connection_get_id (NMSettingConnection *setting);

-Adds a new secondary connetion UUID to the setting. +Returns the "id" property of the connection.
-
+
+++ @@ -385,44 +382,24 @@ Adds a new secondary connetion UUID to the setting. - - - - - +

setting :

sec_uuid :
the secondary connection UUID to add

Returns :
-TRUE if the secondary connection UUID was added; FALSE if the UUID -was already present the connection ID

-
Since 0.9.8
-
-
-
-
nm_setting_connection_error_quark ()
-
GQuark nm_setting_connection_error_quark (void);
-
-Registers an error quark for NMSettingConnection if necessary. -
-
-- - - - -

Returns :
the error quark used for NMSettingConnection errors.

-
nm_setting_connection_get_autoconnect ()
-
gboolean nm_setting_connection_get_autoconnect - (NMSettingConnection *setting);
+
nm_setting_connection_get_uuid ()
+
const char * nm_setting_connection_get_uuid (NMSettingConnection *setting);

-Returns the "autoconnect" property of the connection. +Returns the "uuid" property of the connection.
-
+
+++ @@ -431,7 +408,7 @@ Returns the Returns :
- +

setting :
the connection's autoconnect behavior the connection UUID

@@ -444,8 +421,11 @@ Returns the "type" property of the connection.
-
+
+++ @@ -461,13 +441,17 @@ Returns the -
nm_setting_connection_get_id ()
-
const char * nm_setting_connection_get_id (NMSettingConnection *setting);
+
nm_setting_connection_get_autoconnect ()
+
gboolean nm_setting_connection_get_autoconnect + (NMSettingConnection *setting);
-Returns the "id" property of the connection. +Returns the "autoconnect" property of the connection.
-

setting :

+
+++ @@ -476,20 +460,23 @@ Returns the Returns :
- +

setting :
the connection ID the connection's autoconnect behavior

-
nm_setting_connection_get_master ()
-
const char * nm_setting_connection_get_master (NMSettingConnection *setting);
+
nm_setting_connection_get_timestamp ()
+
guint64 nm_setting_connection_get_timestamp (NMSettingConnection *setting);

-Returns the "master" property of the connection. +Returns the "timestamp" property of the connection.
-
+
+++ @@ -498,23 +485,23 @@ Returns the Returns :
- +

setting :
interface name of the master device or UUID of the master -connection. the connection's timestamp

-
nm_setting_connection_get_num_permissions ()
-
guint32 nm_setting_connection_get_num_permissions - (NMSettingConnection *setting);
+
nm_setting_connection_get_read_only ()
+
gboolean nm_setting_connection_get_read_only (NMSettingConnection *setting);

-Returns the number of entires in the "permissions" -property of this setting. +Returns the "read-only" property of the connection.
-
+
+++ @@ -523,18 +510,26 @@ property of this setting. - +

setting :

Returns :
the number of permissions entires +TRUE if the connection is read-only, FALSE if it is not

-
nm_setting_connection_get_num_secondaries ()
-
guint32 nm_setting_connection_get_num_secondaries +
nm_setting_connection_get_num_permissions ()
+
guint32 nm_setting_connection_get_num_permissions (NMSettingConnection *setting);
-
+
+Returns the number of entires in the "permissions" +property of this setting. +
+
+++ @@ -543,11 +538,10 @@ property of this setting. - +

setting :

Returns :
the number of configured secondary connection UUIDs the number of permissions entires

-
Since 0.9.8

@@ -562,8 +556,11 @@ property of this setting. Retrieve one of the entries of the "permissions" property of this setting.
-
+
+++ @@ -585,7 +582,7 @@ of this setting. - + @@ -597,13 +594,16 @@ of this setting.
-
nm_setting_connection_get_read_only ()
-
gboolean nm_setting_connection_get_read_only (NMSettingConnection *setting);
+
nm_setting_connection_get_zone ()
+
const char * nm_setting_connection_get_zone (NMSettingConnection *setting);

-Returns the "read-only" property of the connection. +Returns the "zone" property of the connection.
-

setting :

out_detail :
on return, the permission detail (at this time, always NULL) on return, the permission detail (at this time, always NULL)

Returns :

+
+++ @@ -612,19 +612,25 @@ Returns the Returns :
- +

setting :
-TRUE if the connection is read-only, FALSE if it is not the trust level of a connection

-
nm_setting_connection_get_secondary ()
-
const char * nm_setting_connection_get_secondary (NMSettingConnection *setting, - guint32 idx);
-
+
nm_setting_connection_permissions_user_allowed ()
+
gboolean nm_setting_connection_permissions_user_allowed + (NMSettingConnection *setting, + const char *uname);
+
+Checks whether the given username is allowed to view/access this connection. +
+
+++ @@ -632,28 +638,36 @@ Returns the idx :
- + + - +

setting :
the zero-based index of the secondary connection UUID entry
uname :
the user name to check permissions for

Returns :
the secondary connection UUID at index idx - +TRUE if the requested user is allowed to view this connection, +FALSE if the given user is not allowed to view this connection

-
Since 0.9.8

-
nm_setting_connection_get_slave_type ()
-
const char * nm_setting_connection_get_slave_type - (NMSettingConnection *setting);
+
nm_setting_connection_add_permission ()
+
gboolean nm_setting_connection_add_permission + (NMSettingConnection *setting, + const char *ptype, + const char *pitem, + const char *detail);

-Returns the "slave-type" property of the connection. +Adds a permission to the connection's permission list. At this time, only +the "user" permission type is supported, and pitem must be a username. See +"permissions": for more details.
-
+
+++ @@ -661,43 +675,42 @@ Returns the Returns :
- + + - -

setting :
the type of slave this connection is, if any
ptype :
the permission type; at this time only "user" is supported
-
-
-
-
nm_setting_connection_get_timestamp ()
-
guint64 nm_setting_connection_get_timestamp (NMSettingConnection *setting);
-
-Returns the "timestamp" property of the connection. -
-
-- - - + + + + + - +

setting :
the NMSettingConnection +
pitem :
the permission item formatted as required for ptype +
detail :
unused at this time; must be NULL. [allow-none]

Returns :
the connection's timestamp TRUE if the permission was unique and was successfully added to the +list, FALSE if ptype or pitem was invalid or it the permission was already +present in the list

-
nm_setting_connection_get_uuid ()
-
const char * nm_setting_connection_get_uuid (NMSettingConnection *setting);
+
nm_setting_connection_remove_permission ()
+
void nm_setting_connection_remove_permission + (NMSettingConnection *setting, + guint32 idx);

-Returns the "uuid" property of the connection. +Removes the permission at index idx from the connection.
-
+
+++ @@ -705,21 +718,24 @@ Returns the Returns :
- + +

setting :
the connection UUID
idx :
the zero-based index of the permission to remove

-
nm_setting_connection_get_zone ()
-
const char * nm_setting_connection_get_zone (NMSettingConnection *setting);
+
nm_setting_connection_get_master ()
+
const char * nm_setting_connection_get_master (NMSettingConnection *setting);

-Returns the "zone" property of the connection. +Returns the "master" property of the connection.
-
+
+++ @@ -728,7 +744,8 @@ Returns the Returns :
- +

setting :
the trust level of a connection interface name of the master device or UUID of the master +connection.

@@ -738,8 +755,11 @@ Returns the
nm_setting_connection_is_slave_type ()

gboolean nm_setting_connection_is_slave_type (NMSettingConnection *setting, const char *type);
-
+
+++ @@ -761,30 +781,40 @@ against setting's slave type
-
nm_setting_connection_new ()
-
NMSetting * nm_setting_connection_new (void);
+
nm_setting_connection_get_slave_type ()
+
const char * nm_setting_connection_get_slave_type + (NMSettingConnection *setting);

-Creates a new NMSettingConnection object with default values. +Returns the "slave-type" property of the connection.
-

setting :

+
+- ++ + + + + + + - - + + +

setting :
the NMSettingConnection +

Returns :
the new empty NMSettingConnection object
the type of slave this connection is, if any

-
nm_setting_connection_permissions_user_allowed ()
-
gboolean nm_setting_connection_permissions_user_allowed - (NMSettingConnection *setting, - const char *uname);
-
-Checks whether the given username is allowed to view/access this connection. -
-
+
nm_setting_connection_get_num_secondaries ()
+
guint32 nm_setting_connection_get_num_secondaries + (NMSettingConnection *setting);
+
+++ @@ -792,29 +822,55 @@ Checks whether the given username is allowed to view/access this connection. - - + + + + +

setting :

uname :
the user name to check permissions for
Returns :
the number of configured secondary connection UUIDs
+
Since 0.9.8
+
+
+
+
nm_setting_connection_get_secondary ()
+
const char * nm_setting_connection_get_secondary (NMSettingConnection *setting, + guint32 idx);
+
++++ + + + + + + + + - +

setting :
the NMSettingConnection +
idx :
the zero-based index of the secondary connection UUID entry

Returns :
-TRUE if the requested user is allowed to view this connection, -FALSE if the given user is not allowed to view this connection the secondary connection UUID at index idx +

+
Since 0.9.8

-
nm_setting_connection_remove_permission ()
-
void nm_setting_connection_remove_permission - (NMSettingConnection *setting, - guint32 idx);
+
nm_setting_connection_add_secondary ()
+
gboolean nm_setting_connection_add_secondary (NMSettingConnection *setting, + const char *sec_uuid);

-Removes the permission at index idx from the connection. +Adds a new secondary connetion UUID to the setting.
-
+
+++ @@ -822,11 +878,18 @@ Removes the permission at index idx from - - + + + + + +

setting :

idx :
the zero-based index of the permission to remove
sec_uuid :
the secondary connection UUID to add
Returns :
+TRUE if the secondary connection UUID was added; FALSE if the UUID +was already present

+
Since 0.9.8

@@ -837,8 +900,11 @@ Removes the permission at index idx from
Removes the secondary coonnection UUID at index idx.
-
+
+++ @@ -998,6 +1064,6 @@ default zone as defined by the firewall.

- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

setting :

`setting` :	the NMSettingConnection -
`ptype` :	the permission type; at this time only "user" is supported
`pitem` :	the permission item formatted as required for `ptype` -
`detail` :	unused at this time; must be `NULL`. [allow-none] -
Returns :	TRUE if the permission was unique and was successfully added to the -list, FALSE if `ptype` or `pitem` was invalid or it the permission was already -present in the list
the new empty NMSettingConnection object

`setting` :
`sec_uuid` :	the secondary connection UUID to add
Returns :	-`TRUE` if the secondary connection UUID was added; `FALSE` if the UUID -was already present	the connection ID

`setting` :
Returns :	the number of permissions entires	+`TRUE` if the connection is read-only, `FALSE` if it is not

`setting` :
Returns :	the number of configured secondary connection UUIDs	the number of permissions entires

`setting` :
`out_detail` :	on return, the permission detail (at this time, always NULL)	on return, the permission detail (at this time, always `NULL`)
Returns :

`setting` :	the zero-based index of the secondary connection UUID entry	`uname` :	the user name to check permissions for
Returns :	the secondary connection UUID at index `idx` -	+`TRUE` if the requested user is allowed to view this connection, +`FALSE` if the given user is not allowed to view this connection

`setting` :	the NMSettingConnection +	`pitem` :	the permission item formatted as required for `ptype` +
`detail` :	unused at this time; must be `NULL`. [allow-none]
Returns :	the connection's timestamp	TRUE if the permission was unique and was successfully added to the +list, FALSE if `ptype` or `pitem` was invalid or it the permission was already +present in the list

`setting` :	the NMSettingConnection +
`idx` :	the zero-based index of the secondary connection UUID entry
Returns :	-`TRUE` if the requested user is allowed to view this connection, -`FALSE` if the given user is not allowed to view this connection	the secondary connection UUID at index `idx` +

`setting` :
`idx` :	the zero-based index of the permission to remove	`sec_uuid` :	the secondary connection UUID to add
Returns :	+`TRUE` if the secondary connection UUID was added; `FALSE` if the UUID +was already present

Object Hierarchy

Properties

Details

NMSettingConnection

NMSettingConnectionClass

NM_SETTING_CONNECTION_SETTING_NAME

NM_SETTING_CONNECTION_AUTOCONNECT

NM_SETTING_CONNECTION_ERROR

NM_SETTING_CONNECTION_ERROR

nm_setting_connection_error_quark ()

NM_SETTING_CONNECTION_MASTER

NM_SETTING_CONNECTION_UUID

NM_SETTING_CONNECTION_PERMISSIONS

NM_SETTING_CONNECTION_TYPE

NM_SETTING_CONNECTION_AUTOCONNECT

NM_SETTING_CONNECTION_TIMESTAMP

NM_SETTING_CONNECTION_SECONDARIES

NM_SETTING_CONNECTION_PERMISSIONS

NM_SETTING_CONNECTION_SETTING_NAME

NM_SETTING_CONNECTION_ZONE

NM_SETTING_CONNECTION_SLAVE_TYPE

NM_SETTING_CONNECTION_MASTER

NM_SETTING_CONNECTION_TIMESTAMP

NM_SETTING_CONNECTION_SLAVE_TYPE

NM_SETTING_CONNECTION_TYPE

NM_SETTING_CONNECTION_SECONDARIES

NM_SETTING_CONNECTION_UUID

NMSettingConnection

NM_SETTING_CONNECTION_ZONE

NMSettingConnectionClass

nm_setting_connection_add_permission ()

nm_setting_connection_new ()

nm_setting_connection_add_secondary ()

nm_setting_connection_get_id ()

nm_setting_connection_error_quark ()

nm_setting_connection_get_autoconnect ()

nm_setting_connection_get_uuid ()

nm_setting_connection_get_id ()

nm_setting_connection_get_autoconnect ()

nm_setting_connection_get_master ()

nm_setting_connection_get_timestamp ()

nm_setting_connection_get_num_permissions ()

nm_setting_connection_get_read_only ()

nm_setting_connection_get_num_secondaries ()

nm_setting_connection_get_num_permissions ()

nm_setting_connection_get_read_only ()

nm_setting_connection_get_zone ()

nm_setting_connection_get_secondary ()

nm_setting_connection_permissions_user_allowed ()

nm_setting_connection_get_slave_type ()

nm_setting_connection_add_permission ()

nm_setting_connection_get_timestamp ()

nm_setting_connection_get_uuid ()

nm_setting_connection_remove_permission ()

nm_setting_connection_get_zone ()

nm_setting_connection_get_master ()

nm_setting_connection_is_slave_type ()

nm_setting_connection_new ()

nm_setting_connection_get_slave_type ()

nm_setting_connection_permissions_user_allowed ()

nm_setting_connection_get_num_secondaries ()

nm_setting_connection_get_secondary ()

nm_setting_connection_remove_permission ()

nm_setting_connection_add_secondary ()