From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/NMWimaxNsp.html | 539 ++++++++++++++++++++++------------------ 1 file changed, 303 insertions(+), 236 deletions(-) (limited to 'docs/libnm/html/NMWimaxNsp.html') diff --git a/docs/libnm/html/NMWimaxNsp.html b/docs/libnm/html/NMWimaxNsp.html index fa705867..6b4d8307 100644 --- a/docs/libnm/html/NMWimaxNsp.html +++ b/docs/libnm/html/NMWimaxNsp.html @@ -2,36 +2,28 @@ -NMWimaxNsp +libnm Reference Manual: NMWimaxNsp - + - - - - - - - - - - + + + + + + +
@@ -39,312 +31,387 @@

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

-
+

Functions

+
--++ - - + + + + + - - + - - + - - +

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

unknown network type +const char * + +nm_wimax_nsp_get_name () +
+guint32 + +nm_wimax_nsp_get_signal_quality ()

NM_WIMAX_NSP_NETWORK_TYPE_HOME

home network + +NMWimaxNspNetworkType + +nm_wimax_nsp_get_network_type ()

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

partner network + +GPtrArray * + +nm_wimax_nsp_filter_connections ()

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

roaming partner network + +gboolean + +nm_wimax_nsp_connection_valid ()
-
-
-

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 -

-
+
+

Properties

+
--+++ - - + + + - - + + + + + + + +

nsp :

a NMWimaxNsp - +gchar *nameRead

Returns :

the nameNMWimaxNspNetworkTypenetwork-typeRead
guintsignal-qualityRead
-
-
-

nm_wimax_nsp_get_signal_quality ()

-
guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);
-

-Gets the WPA signal quality of the wimax NSP. -

-
+
+

Types and Values

+
--++ - - + + + + + + + + + + - - + +

nsp :

a NMWimaxNsp -#defineNM_WIMAX_NSP_NAME
#defineNM_WIMAX_NSP_SIGNAL_QUALITY
#defineNM_WIMAX_NSP_NETWORK_TYPE

Returns :

the signal qualityenumNMWimaxNspNetworkType
-
-
-

nm_wimax_nsp_get_network_type ()

-
NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);
+
+

Object Hierarchy

+
    GEnum
+    ╰── NMWimaxNspNetworkType
+    GObject
+    ╰── NMObject
+        ╰── NMWimaxNsp
+
+
+
+

Description

-Gets the network type of the wimax NSP.

-
+ +
+

Functions

+
+

nm_wimax_nsp_get_name ()

+
const char *
+nm_wimax_nsp_get_name (NMWimaxNsp *nsp);
+

Gets the name of the wimax NSP

+
+

Parameters

+
--++++ + + + + + +

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.

+
+

Parameters

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

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.

+
+

Parameters

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

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.

+
+

Parameters

+
++++ - - + + + - - + + +

nsp :

a NMWimaxNsp -

nsp

an NMWimaxNsp to filter connections for

 

Returns :

the network type

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

-
+

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.

+
+

Parameters

+
--+++ - - - - - - + + + - - + + +

nsp :

an NMWimaxNsp to filter connections for

connections :

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

nsp

an NMWimaxNsp to validate connection +against

 

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] -

connection

an NMConnection to validate against nsp +

 
+
+

Returns

+

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

+

+
+
+
+
+

Types and Values

+
+

NM_WIMAX_NSP_NAME

+
#define NM_WIMAX_NSP_NAME           "name"
+
+

+

+
-

nm_wimax_nsp_connection_valid ()

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

NM_WIMAX_NSP_SIGNAL_QUALITY

+
#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality"
+

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

-
+ +
+
+

NM_WIMAX_NSP_NETWORK_TYPE

+
#define NM_WIMAX_NSP_NETWORK_TYPE   "network-type"
+
+

+

+
+
+
+

enum NMWimaxNspNetworkType

+

WiMAX network type.

+
+

Members

+
--+++ - - + + + - - + + - - + + + + + + + +

nsp :

an NMWimaxNsp to validate connection against

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

 +

unknown network type

+		 

connection :

an NMConnection to validate against nsp +

NM_WIMAX_NSP_NETWORK_TYPE_HOME

 +

home network

 

Returns :

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

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

 +

partner network

+		 

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

 +

roaming partner network

+		 
+

Property Details

-

The "name" property

-
  "name"                     gchar*                : Read
-

-The name of the WiMAX NSP. -

+

The “name” property

+
  “name”                     gchar *
+

+

Flags: Read

Default value: NULL

-

The "network-type" property

-
  "network-type"             NMWimaxNspNetworkType  : Read
-

-The network type of the WiMAX NSP. -

+

The “network-type” property

+
  “network-type”             NMWimaxNspNetworkType
+

+

Flags: Read

Default value: NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

-

The "signal-quality" property

-
  "signal-quality"           guint                 : Read
-

-The signal quality of the WiMAX NSP. -

+

The “signal-quality” property

+
  “signal-quality”           guint
+

+

Flags: Read

Allowed values: <= 100

Default value: 0

@@ -352,6 +419,6 @@ The signal quality of the WiMAX NSP.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5