NMWimaxNsp: libnm Reference Manual

## NMWimaxNsp NMWimaxNsp |

## Functions

const char * | nm_wimax_nsp_get_name ()
guint32 | nm_wimax_nsp_get_signal_quality ()
NMWimaxNspNetworkType | nm_wimax_nsp_get_network_type ()
GPtrArray * | nm_wimax_nsp_filter_connections ()
gboolean | nm_wimax_nsp_connection_valid ()

## Properties

gchar * | name | Read
NMWimaxNspNetworkType | network-type | Read
guint | signal-quality | Read

## Types and Values

#define | NM_WIMAX_NSP_NAME
#define | NM_WIMAX_NSP_SIGNAL_QUALITY
#define | NM_WIMAX_NSP_NETWORK_TYPE
| NMWimaxNsp

## Object Hierarchy

        GObject
        ╰── NMObject
            ╰── NMWimaxNsp

## Implemented Interfaces

NMWimaxNsp implements GInitable and GAsyncInitable.

## Description

## 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 | 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 full][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.

#### Parameters

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.

## Types and Values

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

### NMWimaxNsp

    typedef struct _NMWimaxNsp NMWimaxNsp;

## Property Details

### The `“name”` property

      “name”                     gchar *

The name of the WiMAX NSP.

Flags: Read

Default value: NULL

### The `“network-type”` property

      “network-type”             NMWimaxNspNetworkType

The network type of the WiMAX NSP.

Flags: Read

Default value: NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN

### The `“signal-quality”` property

      “signal-quality”           guint

The signal quality of the WiMAX NSP.

Flags: Read

Allowed values: <= 100

Default value: 0