## NMObject

NMObject

## Synopsis

    enum                NMObjectError;
    #define             NM_OBJECT_ERROR
    GQuark              nm_object_error_quark               (void);
    #define             NM_OBJECT_DBUS_CONNECTION
    #define             NM_OBJECT_DBUS_PATH
                        NMObject;
                        NMObjectClass;
    DBusGConnection *   nm_object_get_connection            (NMObject *object);
    const char *        nm_object_get_path                  (NMObject *object);

## Object Hierarchy

      GObject
       +----NMObject
             +----NMClient
             +----NMDevice
             +----NMWimaxNsp
             +----NMAccessPoint
             +----NMIP4Config
             +----NMIP6Config
             +----NMActiveConnection
             +----NMDHCP4Config
             +----NMDHCP6Config

## Implemented Interfaces

NMObject implements GInitable and GAsyncInitable.

## Properties

      "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only
      "dbus-path"                gchar*                : Read / Write / Construct Only

## Signals

      "object-creation-failed"                         : Run First

## Description

## Details

### enum NMObjectError

    typedef enum {
    	NM_OBJECT_ERROR_UNKNOWN = 0,
    	NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE,
    } NMObjectError;

Describes errors that may result from operations involving a NMObject.

`NM_OBJECT_ERROR_UNKNOWN` | unknown or unclassified error
`NM_OBJECT_ERROR_OBJECT_CREATION_FAILURE` | an error ocured while creating an NMObject

### NM_OBJECT_ERROR

    #define NM_OBJECT_ERROR nm_object_error_quark ()

### nm_object_error_quark ()

    GQuark              nm_object_error_quark               (void);

Registers an error quark for NMObject if necessary.

Returns : | the error quark used for NMObject errors.

### NM_OBJECT_DBUS_CONNECTION

    #define NM_OBJECT_DBUS_CONNECTION "dbus-connection"

### NM_OBJECT_DBUS_PATH

    #define NM_OBJECT_DBUS_PATH "dbus-path"

### NMObject

    typedef struct _NMObject NMObject;

### NMObjectClass

    typedef struct {
    	GObjectClass parent;

    	/* Signals */
    	/* The "object-creation-failed" signal is PRIVATE for libnm-glib and
    	 * is not meant for any external usage.  It indicates that an error
    	 * occured during creation of an object.
    	 */
    	void (*object_creation_failed) (NMObject *master_object,
    	                                GError *error,
    	                                char *failed_path);

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    	void (*_reserved5) (void);
    	void (*_reserved6) (void);
    } NMObjectClass;

### nm_object_get_connection ()

    DBusGConnection *   nm_object_get_connection            (NMObject *object);

Gets the NMObject's DBusGConnection.

`object` : | a NMObject
Returns : | the connection. [transfer none]

### nm_object_get_path ()

    const char *        nm_object_get_path                  (NMObject *object);

Gets the DBus path of the NMObject.

`object` : | a NMObject
Returns : | the object's path. This is the internal string used by the device, and must not be modified.

## Property Details

### The `"dbus-connection"` property

      "dbus-connection"          DBusGConnection*      : Read / Write / Construct Only

Connection.

### The `"dbus-path"` property

      "dbus-path"                gchar*                : Read / Write / Construct Only

DBus Object Path.

Default value: NULL

## Signal Details

### The `"object-creation-failed"` signal

    void                user_function                      (NMObject *master_object,
                                                            gpointer  error,
                                                            gpointer  failed_path,
                                                            gpointer  user_data)          : Run First

Indicates that an error occured while creating an NMObject object during property handling of `master_object`.

Note: Be aware that the signal is private for libnm-glib's internal use.

`master_object` : | the object that received the signal
`error` : | the error that occured while creating object
`failed_path` : | object path of the failed object
`user_data` : | user data set when the signal handler was connected.