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/NMSettingInfiniband.html | 628 +++++++++++++++++-------------- 1 file changed, 351 insertions(+), 277 deletions(-) (limited to 'docs/libnm/html/NMSettingInfiniband.html') diff --git a/docs/libnm/html/NMSettingInfiniband.html b/docs/libnm/html/NMSettingInfiniband.html index 42a8063c..d68c9929 100644 --- a/docs/libnm/html/NMSettingInfiniband.html +++ b/docs/libnm/html/NMSettingInfiniband.html @@ -2,34 +2,28 @@ -NMSettingInfiniband +libnm Reference Manual: NMSettingInfiniband - + - - - - - - - - - - + + + + + + +
@@ -37,355 +31,435 @@

NMSettingInfiniband

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

- +
-
-

Synopsis

-
#define             NM_SETTING_INFINIBAND_SETTING_NAME
-#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
-struct              NMSettingInfiniband;
-                    NMSettingInfinibandClass;
-NMSetting *         nm_setting_infiniband_new           (void);
-const char *        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);
-const char *        nm_setting_infiniband_get_virtual_interface_name
-                                                        (NMSettingInfiniband *setting);
-
-
-

Object Hierarchy

-
-  GObject
-   +----NMSetting
-         +----NMSettingInfiniband
-
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMSetting * + +nm_setting_infiniband_new () +
const char * + +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 () +
const char * + +nm_setting_infiniband_get_virtual_interface_name () +

Properties

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

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






+gchar *mac-addressRead / Write
guintmtuRead / Write / Construct
gintp-keyRead / Write / Construct

+gchar *parentRead / Write / Construct

+gchar *transport-modeRead / Write / Construct

+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_INFINIBAND_SETTING_NAME
#defineNM_SETTING_INFINIBAND_MAC_ADDRESS
#defineNM_SETTING_INFINIBAND_MTU
#defineNM_SETTING_INFINIBAND_TRANSPORT_MODE
#defineNM_SETTING_INFINIBAND_P_KEY
#defineNM_SETTING_INFINIBAND_PARENT
+
+
+

Object Hierarchy

+
    GObject
+    ╰── NMSetting
+        ╰── NMSettingInfiniband

Description

-

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

+

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

-

Details

+

Functions

-

NM_SETTING_INFINIBAND_SETTING_NAME

-
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
-
-

-

+

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]

-
-
-

NM_SETTING_INFINIBAND_MAC_ADDRESS

-
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
-
-

-

-

NM_SETTING_INFINIBAND_MTU

-
#define NM_SETTING_INFINIBAND_MTU            "mtu"
-
-

-

+

nm_setting_infiniband_get_mac_address ()

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

Parameters

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

setting

the NMSettingInfiniband

 
-
-
-

NM_SETTING_INFINIBAND_TRANSPORT_MODE

-
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
-
-

-

+
+

Returns

+

the “mac-address” property of the setting

+

-
-
-

NM_SETTING_INFINIBAND_P_KEY

-
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
-
-

-

-

NM_SETTING_INFINIBAND_PARENT

-
#define NM_SETTING_INFINIBAND_PARENT         "parent"
-
-

-

+

nm_setting_infiniband_get_mtu ()

+
guint32
+nm_setting_infiniband_get_mtu (NMSettingInfiniband *setting);
+
+

Parameters

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

setting

the NMSettingInfiniband

 
+
+
+

Returns

+

the “mtu” property of the setting

+

-
-
-

struct NMSettingInfiniband

-
struct NMSettingInfiniband;
-

-

-

NMSettingInfinibandClass

-
typedef struct {
-	NMSettingClass parent;
-} NMSettingInfinibandClass;
-
-

-

+

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

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

setting

the NMSettingInfiniband

 
+
+
+

Returns

+

the IPoIB transport mode

+

+
-

nm_setting_infiniband_new ()

-
NMSetting *         nm_setting_infiniband_new           (void);
-

-Creates a new NMSettingInfiniband object with default values. -

-
+

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

+
--+++ - - + + +

Returns :

the new empty NMSettingInfiniband object. [transfer full] -

setting

the NMSettingInfiniband

 
+
+

Returns

+

the IPoIB P_Key

+

+
+
-

nm_setting_infiniband_get_mac_address ()

-
const char *        nm_setting_infiniband_get_mac_address
-                                                        (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 "mac-address" property of the setting

setting

the NMSettingInfiniband

 
+
+

Returns

+

the parent interface name

+

+
+
-

nm_setting_infiniband_get_mtu ()

-
guint32             nm_setting_infiniband_get_mtu       (NMSettingInfiniband *setting);
-
+

nm_setting_infiniband_get_virtual_interface_name ()

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

Returns the interface name created by combining “parent” +and “p-key”. (If either property is unset, this will +return NULL.)

+
+

Parameters

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

setting :

the NMSettingInfiniband -

Returns :

the "mtu" property of the setting

setting

the NMSettingInfiniband

 
+
+

Returns

+

the interface name, or NULL

+

+
+
+
+
+

Types and Values

+
+

NM_SETTING_INFINIBAND_SETTING_NAME

+
#define NM_SETTING_INFINIBAND_SETTING_NAME "infiniband"
+
+

+

+
-

nm_setting_infiniband_get_transport_mode ()

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

NM_SETTING_INFINIBAND_MAC_ADDRESS

+
#define NM_SETTING_INFINIBAND_MAC_ADDRESS    "mac-address"
+

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

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

setting :

the NMSettingInfiniband -

Returns :

the IPoIB transport mode
-

nm_setting_infiniband_get_p_key ()

-
int                 nm_setting_infiniband_get_p_key     (NMSettingInfiniband *setting);
+

NM_SETTING_INFINIBAND_MTU

+
#define NM_SETTING_INFINIBAND_MTU            "mtu"
+

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

+
#define NM_SETTING_INFINIBAND_TRANSPORT_MODE "transport-mode"
+
+

+

+
+
+
+

NM_SETTING_INFINIBAND_P_KEY

+
#define NM_SETTING_INFINIBAND_P_KEY          "p-key"
+

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

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

setting :

the NMSettingInfiniband -

Returns :

the parent interface name
-

nm_setting_infiniband_get_virtual_interface_name ()

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

NM_SETTING_INFINIBAND_PARENT

+
#define NM_SETTING_INFINIBAND_PARENT         "parent"
+

-Returns the interface name created by combining "parent" -and "p-key". (If either property is unset, this will -return NULL.)

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

setting :

the NMSettingInfiniband -

Returns :

the interface name, or NULL -

Property Details

-

The "mac-address" property

-
  "mac-address"              gchar*                : Read / Write
-

-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 “mac-address” property

+
  “mac-address”              gchar *
+

+

Flags: Read / Write

Default value: NULL

-

The "mtu" property

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

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

+

The “mtu” property

+
  “mtu”                      guint
+

+

Flags: Read / Write / Construct

Default value: 0

-

The "p-key" property

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

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

+

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