From 9fae01fa351805b2903e535736e06971bc0b925e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Mon, 29 Nov 2010 00:47:11 +0100 Subject: Imported Upstream version 0.8.1 --- docs/libnm-util/html/NMSettingConnection.html | 514 ++++++++++++++++++++++++++ 1 file changed, 514 insertions(+) create mode 100644 docs/libnm-util/html/NMSettingConnection.html (limited to 'docs/libnm-util/html/NMSettingConnection.html') diff --git a/docs/libnm-util/html/NMSettingConnection.html b/docs/libnm-util/html/NMSettingConnection.html new file mode 100644 index 00000000..8fa7c953 --- /dev/null +++ b/docs/libnm-util/html/NMSettingConnection.html @@ -0,0 +1,514 @@ + + + + +NMSettingConnection + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMSettingConnection

+

NMSettingConnection — Describes general connection properties

+
+
+

Synopsis

+
+#include <nm-setting-connection.h>
+
+#define             NM_SETTING_CONNECTION_SETTING_NAME
+enum                NMSettingConnectionError;
+#define             NM_TYPE_SETTING_CONNECTION_ERROR
+#define             NM_SETTING_CONNECTION_ERROR
+GQuark              nm_setting_connection_error_quark   (void);
+#define             NM_SETTING_CONNECTION_ID
+#define             NM_SETTING_CONNECTION_UUID
+#define             NM_SETTING_CONNECTION_TYPE
+#define             NM_SETTING_CONNECTION_AUTOCONNECT
+#define             NM_SETTING_CONNECTION_TIMESTAMP
+#define             NM_SETTING_CONNECTION_READ_ONLY
+                    NMSettingConnection;
+                    NMSettingConnectionClass;
+GType               nm_setting_connection_get_type      (void);
+NMSetting *         nm_setting_connection_new           (void);
+const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
+const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);
+gboolean            nm_setting_connection_get_autoconnect
+                                                        (NMSettingConnection *setting);
+guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
+gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMSetting
+         +----NMSettingConnection
+
+
+
+

Properties

+
+  "autoconnect"              gboolean              : Read / Write / Construct
+  "id"                       gchar*                : Read / Write
+  "read-only"                gboolean              : Read / Write / Construct
+  "timestamp"                guint64               : Read / Write / Construct
+  "type"                     gchar*                : Read / Write
+  "uuid"                     gchar*                : Read / Write
+
+
+
+

Description

+

+The NMSettingConnection object is a NMSetting subclass that describes +properties that apply to all NMConnection objects, regardless of what type +of network connection they describe. Each NMConnection object must contain +a NMSettingConnection setting. +

+
+
+

Details

+
+

NM_SETTING_CONNECTION_SETTING_NAME

+
#define NM_SETTING_CONNECTION_SETTING_NAME "connection"
+
+

+

+
+
+
+

enum NMSettingConnectionError

+
typedef enum
+{
+	NM_SETTING_CONNECTION_ERROR_UNKNOWN = 0,
+	NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY,
+	NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY,
+	NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND
+} NMSettingConnectionError;
+
+

+Describes errors that may result from operations involving a +NMSettingConnection. +

+
++ + + + + + + + + + + + + + + + + + +

NM_SETTING_CONNECTION_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_CONNECTION_ERROR_INVALID_PROPERTY

the property's value is + invalid +

NM_SETTING_CONNECTION_ERROR_MISSING_PROPERTY

a required property is not + present +

NM_SETTING_CONNECTION_ERROR_TYPE_SETTING_NOT_FOUND

the NMSetting object + referenced by the setting name contained in the + "type" property was not present in the NMConnection +
+
+
+
+

NM_TYPE_SETTING_CONNECTION_ERROR

+
#define NM_TYPE_SETTING_CONNECTION_ERROR (nm_setting_connection_error_get_type ()) 
+
+

+

+
+
+
+

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. +

+
++ + + + +

Returns :

 the error quark used for NMSettingConnection errors. +
+
+
+
+

NM_SETTING_CONNECTION_ID

+
#define NM_SETTING_CONNECTION_ID          "id"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_UUID

+
#define NM_SETTING_CONNECTION_UUID        "uuid"
+
+

+

+
+
+
+

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"
+
+

+

+
+
+
+

NM_SETTING_CONNECTION_READ_ONLY

+
#define NM_SETTING_CONNECTION_READ_ONLY   "read-only"
+
+

+

+
+
+
+

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_get_type ()

+
GType               nm_setting_connection_get_type      (void);
+

+

+
++ + + + +

Returns :

 +
+
+
+
+

nm_setting_connection_new ()

+
NMSetting *         nm_setting_connection_new           (void);
+

+Creates a new NMSettingConnection object with default values. +

+
++ + + + +

Returns :

 the new empty NMSettingConnection object +
+
+
+
+

nm_setting_connection_get_id ()

+
const char *        nm_setting_connection_get_id        (NMSettingConnection *setting);
+

+Returns the "id" property of the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 the connection ID +
+
+
+
+

nm_setting_connection_get_uuid ()

+
const char *        nm_setting_connection_get_uuid      (NMSettingConnection *setting);
+

+Returns the "uuid" property of the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 the connection UUID +
+
+
+
+

nm_setting_connection_get_connection_type ()

+
const char *        nm_setting_connection_get_connection_type
+                                                        (NMSettingConnection *setting);
+

+Returns the "type" property of the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 the connection type +
+
+
+
+

nm_setting_connection_get_autoconnect ()

+
gboolean            nm_setting_connection_get_autoconnect
+                                                        (NMSettingConnection *setting);
+

+Returns the "autoconnect" property of the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 the connection's autoconnect behavior +
+
+
+
+

nm_setting_connection_get_timestamp ()

+
guint64             nm_setting_connection_get_timestamp (NMSettingConnection *setting);
+

+Returns the "timestamp" property of the connection. +

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 the connection's timestamp +
+
+
+
+

nm_setting_connection_get_read_only ()

+
gboolean            nm_setting_connection_get_read_only (NMSettingConnection *setting);
+

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

+
++ + + + + + + + + + +

setting :

the NMSettingConnection +

Returns :

 TRUE if the connection is read-only, FALSE if it is not +
+
+
+
+

Property Details

+
+

The "autoconnect" property

+
  "autoconnect"              gboolean              : Read / Write / Construct
+

+Whether or not the connection should be automatically connected by +NetworkManager when the resources for the connection are available. +TRUE to automatically activate the connection, FALSE to require manual +intervention to activate the connection. Defaults to TRUE. +

+

Default value: TRUE

+
+
+
+

The "id" property

+
  "id"                       gchar*                : Read / Write
+

+A human readable unique idenfier for the connection, like "Work WiFi" or +"T-Mobile 3G". +

+

Default value: NULL

+
+
+
+

The "read-only" property

+
  "read-only"                gboolean              : Read / Write / Construct
+

+TRUE if the connection can be modified using the providing settings +service's D-Bus interface with the right privileges, or FALSE +if the connection is read-only and cannot be modified. +

+

Default value: FALSE

+
+
+
+

The "timestamp" property

+
  "timestamp"                guint64               : Read / Write / Construct
+

+The time, in seconds since the Unix Epoch, that the connection was last +_successfully_ fully activated. +

+

Default value: 0

+
+
+
+

The "type" property

+
  "type"                     gchar*                : Read / Write
+

+The general hardware type of the device used for the network connection, +contains the name of the NMSetting object that describes that hardware +type's parameters. For example, for WiFi devices, the name of the +NMSettingWireless setting. +

+

Default value: NULL

+
+
+
+

The "uuid" property

+
  "uuid"                     gchar*                : Read / Write
+

+A universally unique idenfier for the connection, for example generated +with libuuid. Should be assigned when the connection is created, and +never changed as long as the connection still applies to the same +network. For example, should not be changed when the +"id" or NMSettingIP4Config changes, but might need +to be re-created when the WiFi SSID, mobile broadband network provider, +or "type" changes. +

+

+The UUID must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' +(ie, contains only hexadecimal characters and '-'). A suitable UUID may +be generated by nm_utils_uuid_generate() or +nm_utils_uuid_generate_from_string(). +

+

Default value: NULL

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