<refentry id="camel-CamelDiscoStore">
<refmeta>
<refentrytitle role="top_of_page" id="camel-CamelDiscoStore.top_of_page">CamelDiscoStore</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>CamelDiscoStore</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="camel-CamelDiscoStore.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
struct              <link linkend="CamelDiscoStore">CamelDiscoStore</link>;
enum                <link linkend="CamelDiscoStoreStatus">CamelDiscoStoreStatus</link>;
<link linkend="CamelDiscoStoreStatus">CamelDiscoStoreStatus</link> <link linkend="camel-disco-store-status">camel_disco_store_status</link>          (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *);
<link linkend="void">void</link>                <link linkend="camel-disco-store-set-status">camel_disco_store_set_status</link>        (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *,
                                                         <link linkend="CamelDiscoStoreStatus">CamelDiscoStoreStatus</link> ,
                                                         <link linkend="CamelException">CamelException</link> *);
<link linkend="gboolean">gboolean</link>            <link linkend="camel-disco-store-can-work-offline">camel_disco_store_can_work_offline</link>  (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *);
<link linkend="gboolean">gboolean</link>            <link linkend="camel-disco-store-check-online">camel_disco_store_check_online</link>      (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *store,
                                                         <link linkend="CamelException">CamelException</link> *ex);
<link linkend="void">void</link>                <link linkend="camel-disco-store-prepare-for-offline">camel_disco_store_prepare_for_offline</link>
                                                        (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *store,
                                                         <link linkend="CamelException">CamelException</link> *ex);
</synopsis>
</refsynopsisdiv>









<refsect1 id="camel-CamelDiscoStore.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="camel-CamelDiscoStore.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="CamelDiscoStore" role="struct">
<title>struct CamelDiscoStore</title>
<indexterm zone="CamelDiscoStore"><primary>CamelDiscoStore</primary></indexterm><programlisting>struct CamelDiscoStore {
	CamelStore parent_object;	

	CamelDiscoStoreStatus status;
	CamelDiscoDiary *diary;
};
</programlisting>
<para>

</para></refsect2>
<refsect2 id="CamelDiscoStoreStatus" role="enum">
<title>enum CamelDiscoStoreStatus</title>
<indexterm zone="CamelDiscoStoreStatus"><primary>CamelDiscoStoreStatus</primary></indexterm><programlisting>typedef enum {
	CAMEL_DISCO_STORE_ONLINE,
	CAMEL_DISCO_STORE_OFFLINE,
	CAMEL_DISCO_STORE_RESYNCING
} CamelDiscoStoreStatus;
</programlisting>
<para>

</para></refsect2>
<refsect2 id="camel-disco-store-status" role="function">
<title>camel_disco_store_status ()</title>
<indexterm zone="camel-disco-store-status"><primary>camel_disco_store_status</primary></indexterm><programlisting><link linkend="CamelDiscoStoreStatus">CamelDiscoStoreStatus</link> camel_disco_store_status          (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current online/offline status of <parameter>store</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-store-set-status" role="function">
<title>camel_disco_store_set_status ()</title>
<indexterm zone="camel-disco-store-set-status"><primary>camel_disco_store_set_status</primary></indexterm><programlisting><link linkend="void">void</link>                camel_disco_store_set_status        (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *,
                                                         <link linkend="CamelDiscoStoreStatus">CamelDiscoStoreStatus</link> ,
                                                         <link linkend="CamelException">CamelException</link> *);</programlisting>
<para>
Sets <parameter>store</parameter> to <parameter>status</parameter>. If an error occurrs and the status cannot
be set to <parameter>status</parameter>, <parameter>ex</parameter> will be set.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param2</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>Param3</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-store-can-work-offline" role="function">
<title>camel_disco_store_can_work_offline ()</title>
<indexterm zone="camel-disco-store-can-work-offline"><primary>camel_disco_store_can_work_offline</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_disco_store_can_work_offline  (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>Param1</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether or not <parameter>store</parameter> can be used offline. (Will be
<link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if the store is not caching data to local disk, for example.)
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-store-check-online" role="function">
<title>camel_disco_store_check_online ()</title>
<indexterm zone="camel-disco-store-check-online"><primary>camel_disco_store_check_online</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_disco_store_check_online      (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *store,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>
This checks that <parameter>store</parameter> is online, and sets <parameter>ex</parameter> if it is not. This
can be used as a simple way to set a generic error message in <parameter>ex</parameter>
for operations that won't work offline.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>store</parameter>&nbsp;:</term>
<listitem><simpara> a disconnectable store
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara> a CamelException
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> whether or not <parameter>store</parameter> is online.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-disco-store-prepare-for-offline" role="function">
<title>camel_disco_store_prepare_for_offline ()</title>
<indexterm zone="camel-disco-store-prepare-for-offline"><primary>camel_disco_store_prepare_for_offline</primary></indexterm><programlisting><link linkend="void">void</link>                camel_disco_store_prepare_for_offline
                                                        (<link linkend="CamelDiscoStore">CamelDiscoStore</link> *store,
                                                         <link linkend="CamelException">CamelException</link> *ex);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>store</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ex</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
