kpilot/lib

ConduitAction Class Reference

#include <plugin.h>

Inheritance diagram for ConduitAction:

SyncAction ConduitProxy RecordConduitBase RecordConduit< PCEntry, PCContainer, HHEntry, HHAppInfo, Syncer > List of all members.

Detailed Description

The SyncActions created by the factory should obey at least the argument test, indicating a dry run.

The device link is the link where the sync should run -- don't get the pilotPort() until the sync runs!

setConfig() will be called before the sync starts so that the conduit can read/write metadata and local settings.

Definition at line 260 of file plugin.h.


Public Member Functions

 ConduitAction (KPilotLink *, const char *name=0L, const QStringList &args=QStringList())
virtual ~ConduitAction ()
void finished ()
QString conduitName () const
const SyncMode & syncMode () const
bool isFullSync () const
bool isFirstSync () const

Protected Member Functions

ConflictResolution getConflictResolution () const
bool changeSync (SyncMode::Mode m)
void setConflictResolution (ConflictResolution res)
void setFirstSync (bool first)
bool openDatabases (const QString &dbName, bool *retrieved=0L)

Protected Attributes

PilotDatabasefDatabase
PilotDatabasefLocalDatabase
QString fConduitName
CUDCounterfCtrHH
CUDCounterfCtrPC

Member Function Documentation

bool ConduitAction::changeSync SyncMode::Mode  m  )  [protected]
 

Try to change the sync mode from what it is now to the mode m.

This may fail (ie. changing a backup to a restore is not kosher) and changeSync() will return false then.

Definition at line 439 of file plugin.cc.

void ConduitAction::finished  ) 
 

ConduitAction is done doing work.

Allow it to sanity-check the results

Definition at line 451 of file plugin.cc.

ConflictResolution ConduitAction::getConflictResolution  )  const [inline, protected]
 

Retrieve the conflict resolution setting for this action.

Definition at line 304 of file plugin.h.

bool ConduitAction::isFirstSync  )  const [inline]
 

A first sync (i.e.

database newly fetched from the handheld ) does not check for deleted records, but understands them as added on the other side. The flag is set by the conduits when opening the local database, or the calendar/addressbook (if it is empty). This also implies a full sync.

Definition at line 297 of file plugin.h.

bool ConduitAction::isFullSync  )  const [inline]
 

A full sync happens for eFullSync, eCopyPCToHH and eCopyHHToPC.

It completely ignores all modified flags and walks through all records in the database.

Definition at line 285 of file plugin.h.

bool ConduitAction::openDatabases const QString &  dbName,
bool *  retrieved = 0L
[protected]
 

Open both the local copy of database dbName and the version on the Pilot.

Return true only if both opens succeed. If the local copy of the database does not exist, it is retrieved from the handheld. In this case, retrieved is set to true, otherwise it is left alone (i.e. retains its value and is not explicitly set to false).

Parameters:
dbName database name to open.
retrieved indicator whether the database had to be loaded from the handheld.

Definition at line 323 of file plugin.cc.

const SyncMode& ConduitAction::syncMode  )  const [inline]
 

Retrieve the sync mode set for this action.

Definition at line 278 of file plugin.h.


Member Data Documentation

QString ConduitAction::fConduitName [protected]
 

Name of the conduit; might be changed by subclasses.

Should normally be set in the constructor.

Definition at line 347 of file plugin.h.

CUDCounter* ConduitAction::fCtrHH [protected]
 

Every plugin has 2 CUDCounters--one for keeping track of changes made to PC data and one for keeping track of Palm data.

Definition at line 351 of file plugin.h.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys