GNOME.org

NMWimaxNsp

NMWimaxNsp

Synopsis

#define             NM_WIMAX_NSP_NAME
#define             NM_WIMAX_NSP_SIGNAL_QUALITY
#define             NM_WIMAX_NSP_NETWORK_TYPE
enum                NMWimaxNspNetworkType;
                    NMWimaxNsp;
                    NMWimaxNspClass;
GObject *           nm_wimax_nsp_new                    (DBusGConnection *connection,
                                                         const char *path);
const char *        nm_wimax_nsp_get_name               (NMWimaxNsp *nsp);
guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);
NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);
GSList *            nm_wimax_nsp_filter_connections     (NMWimaxNsp *nsp,
                                                         const GSList *connections);
gboolean            nm_wimax_nsp_connection_valid       (NMWimaxNsp *nsp,
                                                         NMConnection *connection);

Object Hierarchy

  GObject
   +----NMObject
         +----NMWimaxNsp

Implemented Interfaces

NMWimaxNsp implements GInitable and GAsyncInitable.

Properties

  "name"                     gchar*                : Read
  "network-type"             guint                 : Read
  "signal-quality"           guint                 : Read

Description

Details

NM_WIMAX_NSP_NAME

#define NM_WIMAX_NSP_NAME           "name"

NM_WIMAX_NSP_SIGNAL_QUALITY

#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality"

NM_WIMAX_NSP_NETWORK_TYPE

#define NM_WIMAX_NSP_NETWORK_TYPE   "network-type"

enum NMWimaxNspNetworkType

typedef enum {
	NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN         = 0,
	NM_WIMAX_NSP_NETWORK_TYPE_HOME            = 1,
	NM_WIMAX_NSP_NETWORK_TYPE_PARTNER         = 2,
	NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 3
} NMWimaxNspNetworkType;

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

NM_WIMAX_NSP_NETWORK_TYPE_HOME

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

NMWimaxNsp

typedef struct _NMWimaxNsp NMWimaxNsp;

NMWimaxNspClass

typedef struct {
	NMObjectClass parent;

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

nm_wimax_nsp_new ()

GObject *           nm_wimax_nsp_new                    (DBusGConnection *connection,
                                                         const char *path);

Creates a new NMWimaxNsp.

connection :

 the DBusGConnection

path :

 the D-Bus object path of the WiMAX NSP

Returns :

 a new WiMAX NSP. [transfer full]

nm_wimax_nsp_get_name ()

const char *        nm_wimax_nsp_get_name               (NMWimaxNsp *nsp);

Gets the name of the wimax NSP

nsp :

 a NMWimaxNsp

Returns :

 the name

nm_wimax_nsp_get_signal_quality ()

guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);

Gets the WPA signal quality of the wimax NSP.

nsp :

 a NMWimaxNsp

Returns :

 the signal quality

nm_wimax_nsp_get_network_type ()

NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);

Gets the network type of the wimax NSP.

nsp :

 a NMWimaxNsp

Returns :

 the network type

nm_wimax_nsp_filter_connections ()

GSList *            nm_wimax_nsp_filter_connections     (NMWimaxNsp *nsp,
                                                         const GSList *connections);

Filters a given list of connections for a given NMWimaxNsp object and return connections which may be activated with the access point. Any returned connections will match the nsp's network name and other attributes.

nsp :

 an NMWimaxNsp to filter connections for

connections :

 a list of NMConnection objects to filter. [element-type NetworkManager.Connection]

Returns :

 a list of NMConnection objects that could be activated with the given nsp. The elements of the list are owned by their creator and should not be freed by the caller, but the returned list itself is owned by the caller and should be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]

nm_wimax_nsp_connection_valid ()

gboolean            nm_wimax_nsp_connection_valid       (NMWimaxNsp *nsp,
                                                         NMConnection *connection);

Validates a given connection against a given WiMAX NSP to ensure that the connection may be activated with that NSP. The connection must match the nsp's network name and other attributes.

nsp :

 an NMWimaxNsp to validate connection against

connection :

 an NMConnection to validate against nsp

Returns :

 TRUE if the connection may be activated with this WiMAX NSP, FALSE if it cannot be.

Property Details

The "name" property

  "name"                     gchar*                : Read

The name of the WiMAX NSP.

Default value: NULL

The "network-type" property

  "network-type"             guint                 : Read

The network type of the WiMAX NSP.

Default value: 0

The "signal-quality" property

  "signal-quality"           guint                 : Read

The signal quality of the WiMAX NSP.

Allowed values: <= 100

Default value: 0

Generated by GTK-Doc V1.19