From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMWimaxNsp.html | 357 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 357 insertions(+) create mode 100644 docs/libnm/html/NMWimaxNsp.html (limited to 'docs/libnm/html/NMWimaxNsp.html') diff --git a/docs/libnm/html/NMWimaxNsp.html b/docs/libnm/html/NMWimaxNsp.html new file mode 100644 index 00000000..fa705867 --- /dev/null +++ b/docs/libnm/html/NMWimaxNsp.html @@ -0,0 +1,357 @@ + + + + +NMWimaxNsp + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

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

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