From 59c3714a494c3b3765657c0551ad82842d98a7d2 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Sat, 26 Apr 2014 20:55:09 +0200 Subject: Imported Upstream version 0.9.8.10 --- docs/libnm-glib/html/NMWimaxNsp.html | 587 +++++++++++++++++++---------------- 1 file changed, 326 insertions(+), 261 deletions(-) (limited to 'docs/libnm-glib/html/NMWimaxNsp.html') diff --git a/docs/libnm-glib/html/NMWimaxNsp.html b/docs/libnm-glib/html/NMWimaxNsp.html index 34933aaa..0976c9ff 100644 --- a/docs/libnm-glib/html/NMWimaxNsp.html +++ b/docs/libnm-glib/html/NMWimaxNsp.html @@ -2,36 +2,28 @@ -NMWimaxNsp +libnm-glib Reference Manual: NMWimaxNsp - + - - - - - - - - - - + + + + + + +
@@ -39,350 +31,423 @@

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

-

-
+

Functions

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

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

 + +GObject * + +nm_wimax_nsp_new () +
const char * + +nm_wimax_nsp_get_name ()

NM_WIMAX_NSP_NETWORK_TYPE_HOME

 + +guint32 + +nm_wimax_nsp_get_signal_quality ()

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

 + +NMWimaxNspNetworkType + +nm_wimax_nsp_get_network_type ()

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

 + +GSList * + +nm_wimax_nsp_filter_connections () +
+gboolean + +nm_wimax_nsp_connection_valid ()
-
-
-

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

-
+
+

Properties

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

connection :

the DBusGConnection - +gchar *nameRead

path :

the D-Bus object path of the WiMAX NSPguintnetwork-typeRead

Returns :

a new WiMAX NSP. [transfer full] -guintsignal-qualityRead
-
-
-

nm_wimax_nsp_get_name ()

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

-Gets the name of the wimax NSP -

-
+
+

Types and Values

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

nsp :

a NMWimaxNsp -#defineNM_WIMAX_NSP_NAME
#defineNM_WIMAX_NSP_SIGNAL_QUALITY

Returns :

the name#defineNM_WIMAX_NSP_NETWORK_TYPE
enumNMWimaxNspNetworkType
-
-
-

nm_wimax_nsp_get_signal_quality ()

-
guint32             nm_wimax_nsp_get_signal_quality     (NMWimaxNsp *nsp);
+
+

Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMWimaxNsp
+
+
+
+

Description

-Gets the WPA signal quality of the wimax NSP.

-
+ +
+

Functions

+
+

nm_wimax_nsp_new ()

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

Creates a new NMWimaxNsp.

+
+

Parameters

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

nsp :

a NMWimaxNsp -

connection

the DBusGConnection

 

Returns :

the signal quality

path

the D-Bus object path of the WiMAX NSP

 
+
+

Returns

+

a new WiMAX NSP.

+

[transfer full]

+
+
-

nm_wimax_nsp_get_network_type ()

-
NMWimaxNspNetworkType nm_wimax_nsp_get_network_type     (NMWimaxNsp *nsp);
-

-Gets the network type of the wimax NSP. -

-
+

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

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

+
+

Parameters

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

nsp :

a NMWimaxNsp -

nsp

an NMWimaxNsp to filter connections for

 

Returns :

the network type

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

-
+

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 :

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

nsp

an NMWimaxNsp to validate connection +against

 

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

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"
+
+

+

+
+
+
+

NM_WIMAX_NSP_NETWORK_TYPE

+
#define NM_WIMAX_NSP_NETWORK_TYPE   "network-type"
+

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

-
+ +
+
+

enum NMWimaxNspNetworkType

+

+

+
+

Members

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

nsp :

an NMWimaxNsp to validate connection against

NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

  

connection :

an NMConnection to validate against nsp -

NM_WIMAX_NSP_NETWORK_TYPE_HOME

  

NM_WIMAX_NSP_NETWORK_TYPE_PARTNER

  

Returns :

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

NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER

  
+

Property Details

-

The "name" property

-
  "name"                     gchar*                : Read
-

-The name of the WiMAX NSP. -

+

The “name” property

+
  “name”                     gchar *
+

Name.

+

Flags: Read

Default value: NULL

-

The "network-type" property

-
  "network-type"             guint                 : Read
-

-The network type of the WiMAX NSP. -

+

The “network-type” property

+
  “network-type”             guint
+

Network Type.

+

Flags: Read

Default value: 0

-

The "signal-quality" property

-
  "signal-quality"           guint                 : Read
-

-The signal quality of the WiMAX NSP. -

+

The “signal-quality” property

+
  “signal-quality”           guint
+

Signal Quality.

+

Flags: Read

Allowed values: <= 100

Default value: 0

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