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-util/html/NMSettingInfiniband.html | 679 ++++++++++++++------------ 1 file changed, 376 insertions(+), 303 deletions(-) (limited to 'docs/libnm-util/html/NMSettingInfiniband.html') diff --git a/docs/libnm-util/html/NMSettingInfiniband.html b/docs/libnm-util/html/NMSettingInfiniband.html index dc3eb350..f61fe6f7 100644 --- a/docs/libnm-util/html/NMSettingInfiniband.html +++ b/docs/libnm-util/html/NMSettingInfiniband.html @@ -2,34 +2,28 @@ -NMSettingInfiniband +libnm-util Reference Manual: NMSettingInfiniband - + - - - - - - - - - - + + + + + + +
@@ -37,399 +31,478 @@

NMSettingInfiniband

NMSettingInfiniband — Describes connection properties for IP-over-InfiniBand networks

- +
-
-

Synopsis

-
-#include <nm-setting-infiniband.h>
-
-#define             NM_SETTING_INFINIBAND_SETTING_NAME
-enum                NMSettingInfinibandError;
-#define             NM_SETTING_INFINIBAND_ERROR
-GQuark              nm_setting_infiniband_error_quark   (void);
-#define             NM_SETTING_INFINIBAND_MAC_ADDRESS
-#define             NM_SETTING_INFINIBAND_MTU
-#define             NM_SETTING_INFINIBAND_TRANSPORT_MODE
-#define             NM_SETTING_INFINIBAND_P_KEY
-#define             NM_SETTING_INFINIBAND_PARENT
-                    NMSettingInfiniband;
-                    NMSettingInfinibandClass;
-NMSetting *         nm_setting_infiniband_new           (void);
-const GByteArray *  nm_setting_infiniband_get_mac_address
-                                                        (NMSettingInfiniband *setting);
-guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
-const char *        nm_setting_infiniband_get_transport_mode
-                                                        (NMSettingInfiniband *setting);
-int                 nm_setting_infiniband_get_p_key     (NMSettingInfiniband *setting);
-const char *        nm_setting_infiniband_get_parent    (NMSettingInfiniband *setting);
-
-
-
-

Object Hierarchy

-
-  GEnum
-   +----NMSettingInfinibandError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingInfiniband
-
-
-

Properties

-
-  "mac-address"              GArray_guchar_*       : Read / Write
-  "mtu"                      guint                 : Read / Write / Construct
-  "p-key"                    gint                  : Read / Write / Construct
-  "parent"                   gchar*                : Read / Write / Construct
-  "transport-mode"           gchar*                : Read / Write / Construct
-
-
-
-

Description

-

-The NMSettingInfiniband object is a NMSetting subclass that describes properties -necessary for connection to IP-over-InfiniBand networks. -

-
-
-

Details

-
-

NM_SETTING_INFINIBAND_SETTING_NAME

-
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
-
-

-

-
-
-
-

enum NMSettingInfinibandError

-
typedef enum {
-	NM_SETTING_INFINIBAND_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
-	NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY  /*< nick=MissingProperty >*/
-} NMSettingInfinibandError;
-
-
+

Functions

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

NM_SETTING_INFINIBAND_ERROR_UNKNOWN

unknown or unclassified error + +GQuark + +nm_setting_infiniband_error_quark ()

NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY

the property was invalid + +NMSetting * + +nm_setting_infiniband_new ()

NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY

the property was missing and is -required +const GByteArray * + +nm_setting_infiniband_get_mac_address () +
+guint32 + +nm_setting_infiniband_get_mtu () +
const char * + +nm_setting_infiniband_get_transport_mode () +
+int + +nm_setting_infiniband_get_p_key () +
const char * + +nm_setting_infiniband_get_parent ()
-
-
-

NM_SETTING_INFINIBAND_ERROR

-
#define NM_SETTING_INFINIBAND_ERROR nm_setting_infiniband_error_quark ()
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GArray_guchar_ *mac-addressRead / Write
guintmtuRead / Write / Construct
gintp-keyRead / Write / Construct
+gchar *parentRead / Write / Construct
+gchar *transport-modeRead / Write / Construct
-
-
-

nm_setting_infiniband_error_quark ()

-
GQuark              nm_setting_infiniband_error_quark   (void);
-

-Registers an error quark for NMSettingInfiniband if necessary. -

-
+
+

Types and Values

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

Returns :

the error quark used for NMSettingInfiniband errors.
#defineNM_SETTING_INFINIBAND_SETTING_NAME
enumNMSettingInfinibandError
#defineNM_SETTING_INFINIBAND_ERROR
#defineNM_SETTING_INFINIBAND_MAC_ADDRESS
#defineNM_SETTING_INFINIBAND_MTU
#defineNM_SETTING_INFINIBAND_TRANSPORT_MODE
#defineNM_SETTING_INFINIBAND_P_KEY
#defineNM_SETTING_INFINIBAND_PARENT
-
-
-

NM_SETTING_INFINIBAND_MAC_ADDRESS

-
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+

+
Object Hierarchy

+
    GEnum
+    ╰── NMSettingInfinibandError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingInfiniband
 

-

-

 

-

-

-
NM_SETTING_INFINIBAND_MTU

-
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+

+
Includes

+
#include <nm-setting-infiniband.h>
 

-

-

 

-

-

-
NM_SETTING_INFINIBAND_TRANSPORT_MODE

-
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
-

-

-

+

+
Description

+
The NMSettingInfiniband object is a NMSetting subclass that describes properties
+necessary for connection to IP-over-InfiniBand networks.

 

-

+

+
Functions

 

-
NM_SETTING_INFINIBAND_P_KEY

-
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
-

-

-

+
nm_setting_infiniband_error_quark ()

+
GQuark
+nm_setting_infiniband_error_quark (void);

+
Registers an error quark for NMSettingInfiniband if necessary.

+

+
Returns

+
 the error quark used for NMSettingInfiniband errors.

+

+

 

 

 

-
NM_SETTING_INFINIBAND_PARENT

-
#define NM_SETTING_INFINIBAND_PARENT         "parent"
-

-

-

+
nm_setting_infiniband_new ()

+
NMSetting *
+nm_setting_infiniband_new (void);

+
Creates a new NMSettingInfiniband object with default values.

+

+
Returns

+
 the new empty NMSettingInfiniband object. 

+
[transfer full]

+

 

 

 

-
NMSettingInfiniband

-
typedef struct _NMSettingInfiniband NMSettingInfiniband;

-

-

+
nm_setting_infiniband_get_mac_address ()

+
const GByteArray *
+nm_setting_infiniband_get_mac_address (NMSettingInfiniband *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingInfiniband
 

+

+

+
Returns

+
 the “mac-address” property of the setting

+

+

 

 

 

-
NMSettingInfinibandClass

-
typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingInfinibandClass;
-

-

-

+
nm_setting_infiniband_get_mtu ()

+
guint32
+nm_setting_infiniband_get_mtu (NMSettingInfiniband *setting);

+

+
Parameters

+

+++++
+
+
+
+
+
+





setting
the NMSettingInfiniband
 

+

+

+
Returns

+
 the “mtu” property of the setting

+

+

 

 

 

-
nm_setting_infiniband_new ()

-
NMSetting *         nm_setting_infiniband_new           (void);

-

-Creates a new NMSettingInfiniband object with default values.
-

-

+
nm_setting_infiniband_get_transport_mode ()

+
const char *
+nm_setting_infiniband_get_transport_mode
+                               (NMSettingInfiniband *setting);

+
Returns the transport mode for this device. Either 'datagram' or
+'connected'.

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingInfiniband object. [transfer full]
-
setting
the NMSettingInfiniband
 
 

 

 

+

+
Returns

+
 the IPoIB transport mode

+

+

+

 

 

-
nm_setting_infiniband_get_mac_address ()

-
const GByteArray *  nm_setting_infiniband_get_mac_address
-                                                        (NMSettingInfiniband *setting);

-

+
nm_setting_infiniband_get_p_key ()

+
int
+nm_setting_infiniband_get_p_key (NMSettingInfiniband *setting);

+
Returns the P_Key to use for this device. A value of -1 means to
+use the default P_Key (aka "the P_Key at index 0"). Otherwise it is
+a 16-bit unsigned integer.

+

+
Parameters

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

 





 
setting :
the NMSettingInfiniband
-
Returns :
the "mac-address" property of the setting
setting
the NMSettingInfiniband
 

 

 

+

+
Returns

+
 the IPoIB P_Key

+

+

+

 

 

-
nm_setting_infiniband_get_mtu ()

-
guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);

-

+
nm_setting_infiniband_get_parent ()

+
const char *
+nm_setting_infiniband_get_parent (NMSettingInfiniband *setting);

+
Returns the parent interface name for this device, if set.

+

+
Parameters

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

 





 
setting :
the NMSettingInfiniband
-
Returns :
the "mtu" property of the setting
setting
the NMSettingInfiniband
 

 

 

-

+

+
Returns

+
 the parent interface name

+

+

+

+
+
+

Types and Values

-

nm_setting_infiniband_get_transport_mode ()

-
const char *        nm_setting_infiniband_get_transport_mode
-                                                        (NMSettingInfiniband *setting);
+

NM_SETTING_INFINIBAND_SETTING_NAME

+
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
+

-Returns the transport mode for this device. Either 'datagram' or -'connected'.

-
+ +
+
+

enum NMSettingInfinibandError

+
+

Members

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

setting :

the NMSettingInfiniband +

NM_SETTING_INFINIBAND_ERROR_UNKNOWN

 +

unknown or unclassified error

 

Returns :

the IPoIB transport mode

NM_SETTING_INFINIBAND_ERROR_INVALID_PROPERTY

 +

the property was invalid

+		 

NM_SETTING_INFINIBAND_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

+		 
+
-

nm_setting_infiniband_get_p_key ()

-
int                 nm_setting_infiniband_get_p_key     (NMSettingInfiniband *setting);
+

NM_SETTING_INFINIBAND_ERROR

+
#define NM_SETTING_INFINIBAND_ERROR nm_setting_infiniband_error_quark ()
+

-Returns the P_Key to use for this device. A value of -1 means to -use the default P_Key (aka "the P_Key at index 0"). Otherwise it is -a 16-bit unsigned integer.

-
---- - - - - - - - - - - -

setting :

the NMSettingInfiniband -

Returns :

the IPoIB P_Key
-

nm_setting_infiniband_get_parent ()

-
const char *        nm_setting_infiniband_get_parent    (NMSettingInfiniband *setting);
+

NM_SETTING_INFINIBAND_MAC_ADDRESS

+
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+

-Returns the parent interface name for this device, if set.

-
---- - - - - - - - - - - -

setting :

the NMSettingInfiniband -

Returns :

the parent interface name
+
+
+

NM_SETTING_INFINIBAND_MTU

+
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+
+

+

-
-

Property Details

+
-

The "mac-address" property

-
  "mac-address"              GArray_guchar_*       : Read / Write
+

NM_SETTING_INFINIBAND_TRANSPORT_MODE

+
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
+

-If specified, this connection will only apply to the IPoIB device whose -permanent MAC address matches. This property does not change the MAC -address of the device (i.e. MAC spoofing).

-

The "mtu" property

-
  "mtu"                      guint                 : Read / Write / Construct
+

NM_SETTING_INFINIBAND_P_KEY

+
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
+

-If non-zero, only transmit packets of the specified size or smaller, -breaking larger packets up into multiple frames.

-

Default value: 0

-

The "p-key" property

-
  "p-key"                    gint                  : Read / Write / Construct
+

NM_SETTING_INFINIBAND_PARENT

+
#define NM_SETTING_INFINIBAND_PARENT         "parent"
+

-The InfiniBand P_Key to use for this device. A value of -1 means to use -the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit -unsigned integer, whose high bit is set if it is a "full membership" -P_Key.

+
+
+
+

Property Details

+
+

The “mac-address” property

+
  “mac-address”              GArray_guchar_ *
+

+

Flags: Read / Write

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

+

Flags: Read / Write / Construct

+

Default value: 0

+
+
+
+

The “p-key” property

+
  “p-key”                    gint
+

+

Flags: Read / Write / Construct

Allowed values: [-1,65535]

Default value: -1

-

The "parent" property

-
  "parent"                   gchar*                : Read / Write / Construct
-

-The interface name of the parent device of this device. Normally NULL, -but if the "p_key" property is set, then you must -specify the base device by setting either this property or -"mac-address". -

+

The “parent” property

+
  “parent”                   gchar *
+

+

Flags: Read / Write / Construct

Default value: NULL

-

The "transport-mode" property

-
  "transport-mode"           gchar*                : Read / Write / Construct
-

-The IP-over-InfiniBand transport mode. Either "datagram" or -"connected". -

+

The “transport-mode” property

+
  “transport-mode”           gchar *
+

+

Flags: Read / Write / Construct

Default value: NULL

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