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-util/html/NMSettingSerial.html | 659 +++++++++++++++++------------- 1 file changed, 374 insertions(+), 285 deletions(-) (limited to 'docs/libnm-util/html/NMSettingSerial.html') diff --git a/docs/libnm-util/html/NMSettingSerial.html b/docs/libnm-util/html/NMSettingSerial.html index 16f6d603..8f107269 100644 --- a/docs/libnm-util/html/NMSettingSerial.html +++ b/docs/libnm-util/html/NMSettingSerial.html @@ -2,34 +2,28 @@ -NMSettingSerial +libnm-util Reference Manual: NMSettingSerial - + - - - - - - - - - - + + + + + + +
@@ -38,64 +32,333 @@

NMSettingSerial — Describes connection properties for devices that use serial communications

- +
-
-

Synopsis

-
-#include <nm-setting-serial.h>
-
-#define             NM_SETTING_SERIAL_SETTING_NAME
-enum                NMSettingSerialError;
-#define             NM_SETTING_SERIAL_ERROR
-GQuark              nm_setting_serial_error_quark       (void);
-#define             NM_SETTING_SERIAL_BAUD
-#define             NM_SETTING_SERIAL_BITS
-#define             NM_SETTING_SERIAL_PARITY
-#define             NM_SETTING_SERIAL_STOPBITS
-#define             NM_SETTING_SERIAL_SEND_DELAY
-                    NMSettingSerial;
-                    NMSettingSerialClass;
-NMSetting *         nm_setting_serial_new               (void);
-guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GQuark + +nm_setting_serial_error_quark () +
+NMSetting * + +nm_setting_serial_new () +
+guint + +nm_setting_serial_get_baud () +
+guint + +nm_setting_serial_get_bits () +
+char + +nm_setting_serial_get_parity () +
+guint + +nm_setting_serial_get_stopbits () +
+guint64 + +nm_setting_serial_get_send_delay () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
guintbaudRead / Write / Construct
guintbitsRead / Write / Construct
gcharparityRead / Write / Construct
guint64send-delayRead / Write / Construct
guintstopbitsRead / Write / Construct
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_SERIAL_SETTING_NAME
enumNMSettingSerialError
#defineNM_SETTING_SERIAL_ERROR
#defineNM_SETTING_SERIAL_BAUD
#defineNM_SETTING_SERIAL_BITS
#defineNM_SETTING_SERIAL_PARITY
#defineNM_SETTING_SERIAL_STOPBITS
#defineNM_SETTING_SERIAL_SEND_DELAY

Object Hierarchy

-
-  GEnum
-   +----NMSettingSerialError
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingSerial
+
    GEnum
+    ╰── NMSettingSerialError
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingSerial
-

Properties

-
-  "baud"                     guint                 : Read / Write / Construct
-  "bits"                     guint                 : Read / Write / Construct
-  "parity"                   gchar                 : Read / Write / Construct
-  "send-delay"               guint64               : Read / Write / Construct
-  "stopbits"                 guint                 : Read / Write / Construct
+
Includes

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

Description

-

-The NMSettingSerial object is a NMSetting subclass that describes +

The NMSettingSerial object is a NMSetting subclass that describes properties necessary for connections that may use serial communications, -such as mobile broadband or analog telephone connections. -

+such as mobile broadband or analog telephone connections.

+
+
+

Functions

+
+

nm_setting_serial_error_quark ()

+
GQuark
+nm_setting_serial_error_quark (void);
+

Registers an error quark for NMSettingSerial if necessary.

+
+

Returns

+

the error quark used for NMSettingSerial errors.

+

+
+
+
+
+

nm_setting_serial_new ()

+
NMSetting *
+nm_setting_serial_new (void);
+

Creates a new NMSettingSerial object with default values.

+
+

Returns

+

the new empty NMSettingSerial object.

+

[transfer full]

+
+
+
+
+

nm_setting_serial_get_baud ()

+
guint
+nm_setting_serial_get_baud (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “baud” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_bits ()

+
guint
+nm_setting_serial_get_bits (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “bits” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_parity ()

+
char
+nm_setting_serial_get_parity (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “parity” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_stopbits ()

+
guint
+nm_setting_serial_get_stopbits (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “stopbits” property of the setting

+

+
+
+
+
+

nm_setting_serial_get_send_delay ()

+
guint64
+nm_setting_serial_get_send_delay (NMSettingSerial *setting);
+
+

Parameters

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

setting

the NMSettingSerial

 
+
+
+

Returns

+

the “send-delay” property of the setting

+

+
+
-

Details

+

Types and Values

NM_SETTING_SERIAL_SETTING_NAME

#define NM_SETTING_SERIAL_SETTING_NAME "serial"
@@ -105,45 +368,50 @@ such as mobile broadband or analog telephone connections.
-

enum NMSettingSerialError

-
typedef enum {
-	NM_SETTING_SERIAL_ERROR_UNKNOWN = 0,        /*< nick=UnknownError >*/
-	NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY,   /*< nick=InvalidProperty >*/
-	NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY,   /*< nick=MissingProperty >*/
-	NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING /*< nick=MissingPPPSetting >*/
-} NMSettingSerialError;
-
-
+

enum NMSettingSerialError

+
+

Members

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

NM_SETTING_SERIAL_ERROR_UNKNOWN

unknown or unclassified error +

NM_SETTING_SERIAL_ERROR_UNKNOWN

 +

unknown or unclassified error

 

NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY

the property was invalid +

NM_SETTING_SERIAL_ERROR_INVALID_PROPERTY

 +

the property was invalid

 

NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY

the property was missing and is -required +

NM_SETTING_SERIAL_ERROR_MISSING_PROPERTY

 +

the property was missing and is +required

 

NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING

one of the properties of the -setting requires the connection to contain an NMSettingPPP setting +

NM_SETTING_SERIAL_ERROR_MISSING_PPP_SETTING

 +

one of the properties of the +setting requires the connection to contain an NMSettingPPP setting

 
+

NM_SETTING_SERIAL_ERROR

@@ -154,24 +422,6 @@ setting requires the connection to contain an -

nm_setting_serial_error_quark ()

-
GQuark              nm_setting_serial_error_quark       (void);
-

-Registers an error quark for NMSettingSerial if necessary. -

-
---- - - - - -

Returns :

the error quark used for NMSettingSerial errors.
-
-
-

NM_SETTING_SERIAL_BAUD

#define NM_SETTING_SERIAL_BAUD "baud"
@@ -210,209 +460,48 @@ Registers an error quark for -

NMSettingSerial

-
typedef struct _NMSettingSerial NMSettingSerial;
-

-

-
-
-
-

NMSettingSerialClass

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

-

-
-
-
-

nm_setting_serial_new ()

-
NMSetting *         nm_setting_serial_new               (void);
-

-Creates a new NMSettingSerial object with default values. -

-
---- - - - - -

Returns :

the new empty NMSettingSerial object. [transfer full] -
-
-
-
-

nm_setting_serial_get_baud ()

-
guint               nm_setting_serial_get_baud          (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "baud" property of the setting
-
-
-
-

nm_setting_serial_get_bits ()

-
guint               nm_setting_serial_get_bits          (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "bits" property of the setting
-
-
-
-

nm_setting_serial_get_parity ()

-
char                nm_setting_serial_get_parity        (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "parity" property of the setting
-
-
-
-

nm_setting_serial_get_stopbits ()

-
guint               nm_setting_serial_get_stopbits      (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "stopbits" property of the setting
-
-
-
-

nm_setting_serial_get_send_delay ()

-
guint64             nm_setting_serial_get_send_delay    (NMSettingSerial *setting);
-
---- - - - - - - - - - - -

setting :

the NMSettingSerial -

Returns :

the "send-delay" property of the setting
-

Property Details

-

The "baud" property

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

-Speed to use for communication over the serial port. Note that this value -usually has no effect for mobile broadband modems as they generally -ignore speed settings and use the highest available speed. -

+

The “baud” property

+
  “baud”                     guint
+

Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.

+

Flags: Read / Write / Construct

Default value: 57600

-

The "bits" property

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

-Byte-width of the serial communication. -

+

The “bits” property

+
  “bits”                     guint
+

Byte-width of the serial communication. The 8 in '8n1' for example.

+

Flags: Read / Write / Construct

Allowed values: [5,8]

Default value: 8

-

The "parity" property

-
  "parity"                   gchar                 : Read / Write / Construct
-

-Parity setting of the serial port. Either 'E' for even parity, 'o' for -odd parity, or 'n' for no parity. -

+

The “parity” property

+
  “parity”                   gchar
+

Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.

+

Flags: Read / Write / Construct

Allowed values: [69,111]

Default value: 110

-

The "send-delay" property

-
  "send-delay"               guint64               : Read / Write / Construct
-

-Time to delay between each byte sent to the modem, in microseconds. -

+

The “send-delay” property

+
  “send-delay”               guint64
+

Time to delay between each byte sent to the modem, in microseconds.

+

Flags: Read / Write / Construct

Default value: 0

-

The "stopbits" property

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

-Number of stop bits for communication on the serial port. Either 1 or 2. -The 1 in '8n1' for example. -

+

The “stopbits” property

+
  “stopbits”                 guint
+

Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.

+

Flags: Read / Write / Construct

Allowed values: [1,2]

Default value: 1

@@ -420,6 +509,6 @@ The 1 in '8n1' for example.
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.20
\ No newline at end of file -- cgit 1.3.0-6-gf8a5