NMWimaxNsp

NMWimaxNsp

Synopsis

#define             NM_WIMAX_NSP_NAME
#define             NM_WIMAX_NSP_SIGNAL_QUALITY
#define             NM_WIMAX_NSP_NETWORK_TYPE
enum                NMWimaxNspNetworkType;
struct              NMWimaxNsp;
                    NMWimaxNspClass;
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);
GPtrArray *         nm_wimax_nsp_filter_connections     (NMWimaxNsp *nsp,
                                                         const GPtrArray *connections);
gboolean            nm_wimax_nsp_connection_valid       (NMWimaxNsp *nsp,
                                                         NMConnection *connection);

Object Hierarchy

  GEnum
   +----NMWimaxNspNetworkType
  GObject
   +----NMObject
         +----NMWimaxNsp

Implemented Interfaces

NMWimaxNsp implements GInitable and GAsyncInitable.

Properties

  "name"                     gchar*                : Read
  "network-type"             NMWimaxNspNetworkType  : 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;

WiMAX network type.

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

unknown network type

NM_WIMAX_NSP_NETWORK_TYPE_HOME

home network

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

partner network

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

roaming partner network

struct NMWimaxNsp

struct NMWimaxNsp;

NMWimaxNspClass

typedef struct {
	NMObjectClass parent;
} NMWimaxNspClass;

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

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

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

nsp :

an NMWimaxNsp to filter connections for

connections :

an array of NMConnections to filter. [element-type NMConnection]

Returns :

an array of NMConnections that could be activated with the given nsp. The array should be freed with g_ptr_array_unref() when it is no longer required. [transfer container][element-type NMConnection]

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"             NMWimaxNspNetworkType  : Read

The network type of the WiMAX NSP.

Default value: NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN


The "signal-quality" property

  "signal-quality"           guint                 : Read

The signal quality of the WiMAX NSP.

Allowed values: <= 100

Default value: 0