aboutsummaryrefslogtreecommitdiff
path: root/docs/reference
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@lanedo.com>2012-07-11 10:20:11 +0200
committerAleksander Morgado <aleksander@lanedo.com>2012-08-06 20:06:46 +0200
commit6e3d90e2a4cd0a5b863748b88ab67e959f47f0f6 (patch)
treeeb436b6c705b1657a1c7b3d6facc0be880b98e58 /docs/reference
parentd63570838be002b4e82d4753e3b137aced1bcfe0 (diff)
plugin: new `MM_PLUGIN_CUSTOM_INIT' property
We let plugins execute some custom initialization in the ports, specified by a `MMAsyncMethod'.
Diffstat (limited to 'docs/reference')
-rw-r--r--docs/reference/api/ModemManager-overview.xml14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/reference/api/ModemManager-overview.xml b/docs/reference/api/ModemManager-overview.xml
index 79147e13..ebb81585 100644
--- a/docs/reference/api/ModemManager-overview.xml
+++ b/docs/reference/api/ModemManager-overview.xml
@@ -176,6 +176,20 @@
</para>
<itemizedlist>
<listitem>
+ <para><emphasis>Custom initialization</emphasis></para>
+ <para>
+ This property allows plugins to provide an asynchronous method which will get
+ executed as soon as the AT port gets opened. This method may be used for any
+ purpose, like running an early command in the ports as soon as possible, or
+ querying the modem for info about the port layout.
+ </para>
+ <para>
+ This configuration is specified by the <type>MM_PLUGIN_CUSTOM_INIT</type>
+ property in the <structname>MMPlugin</structname> object provided
+ by the plugin.
+ </para>
+ </listitem>
+ <listitem>
<para><emphasis>AT allowed</emphasis></para>
<para>
This boolean property allows plugins to specify that they expect and support