1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsServicesConfig">
<refmeta>
<refentrytitle role="top_of_page" id="OobsServicesConfig.top_of_page">OobsServicesConfig</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsServicesConfig</refname>
<refpurpose>Object that represents the configuration of services that start/stop during init/shutdown.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsServicesConfig.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link>;
enum <link linkend="OobsRunlevelRole">OobsRunlevelRole</link>;
<link linkend="OobsServicesConfig-struct">OobsServicesConfig</link>;
<link linkend="OobsObject">OobsObject</link>* <link linkend="oobs-services-config-get">oobs_services_config_get</link> (void);
<link linkend="OobsList">OobsList</link>* <link linkend="oobs-services-config-get-services">oobs_services_config_get_services</link> (<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);
<link linkend="GList">GList</link>* <link linkend="oobs-services-config-get-runlevels">oobs_services_config_get_runlevels</link> (<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);
const <link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link>* <link linkend="oobs-services-config-get-default-runlevel">oobs_services_config_get_default_runlevel</link>
(<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsServicesConfig.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="OobsObject">OobsObject</link>
+----OobsServicesConfig
</synopsis>
</refsect1>
<refsect1 id="OobsServicesConfig.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsServicesConfig.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsServicesRunlevel" role="struct">
<title>OobsServicesRunlevel</title>
<indexterm zone="OobsServicesRunlevel"><primary>OobsServicesRunlevel</primary></indexterm><programlisting>typedef struct {
gchar *name;
guint role;
} OobsServicesRunlevel;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsRunlevelRole" role="enum">
<title>enum OobsRunlevelRole</title>
<indexterm zone="OobsRunlevelRole"><primary>OobsRunlevelRole</primary></indexterm><programlisting>typedef enum
{
OOBS_RUNLEVEL_HALT,
OOBS_RUNLEVEL_REBOOT,
OOBS_RUNLEVEL_MONOUSER,
OOBS_RUNLEVEL_MULTIUSER
} OobsRunlevelRole;
</programlisting>
<para>
</para></refsect2>
<refsect2 id="OobsServicesConfig-struct" role="struct">
<title>OobsServicesConfig</title>
<indexterm zone="OobsServicesConfig-struct"><primary>OobsServicesConfig</primary></indexterm><programlisting>typedef struct _OobsServicesConfig OobsServicesConfig;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-services-config-get" role="function">
<title>oobs_services_config_get ()</title>
<indexterm zone="oobs-services-config-get"><primary>oobs_services_config_get</primary></indexterm><programlisting><link linkend="OobsObject">OobsObject</link>* oobs_services_config_get (void);</programlisting>
<para>
Returns the <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link> singleton, which represents
the services that are run during system init.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the singleton <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-services-config-get-services" role="function">
<title>oobs_services_config_get_services ()</title>
<indexterm zone="oobs-services-config-get-services"><primary>oobs_services_config_get_services</primary></indexterm><programlisting><link linkend="OobsList">OobsList</link>* oobs_services_config_get_services (<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);</programlisting>
<para>
Returns an <link linkend="OobsList"><type>OobsList</type></link> containing objects of type <link linkend="OobsService"><type>OobsService</type></link>.
The returned <link linkend="OobsList"><type>OobsList</type></link> is locked, meaning that new elements
can't be added nor removed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> an <link linkend="OobsList"><type>OobsList</type></link> containing the services list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-services-config-get-runlevels" role="function">
<title>oobs_services_config_get_runlevels ()</title>
<indexterm zone="oobs-services-config-get-runlevels"><primary>oobs_services_config_get_runlevels</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_services_config_get_runlevels (<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);</programlisting>
<para>
Returns a list of <link linkend="OobsServicesRunlevel"><type>OobsServicesRunlevel</type></link> describing the available
runlevels.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> list of runlevels. the list must be freed with
<link linkend="g-list-free"><function>g_list_free()</function></link>;
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-services-config-get-default-runlevel" role="function">
<title>oobs_services_config_get_default_runlevel ()</title>
<indexterm zone="oobs-services-config-get-default-runlevel"><primary>oobs_services_config_get_default_runlevel</primary></indexterm><programlisting>const <link linkend="OobsServicesRunlevel">OobsServicesRunlevel</link>* oobs_services_config_get_default_runlevel
(<link linkend="OobsServicesConfig">OobsServicesConfig</link> *config);</programlisting>
<para>
Returns the current runlevel.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>config</parameter> :</term>
<listitem><simpara> An <link linkend="OobsServicesConfig"><type>OobsServicesConfig</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="OobsServicesRunlevel"><type>OobsServicesRunlevel</type></link> describing the current
runlevel. This value must not be freed, modified,
or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|