kpilot/lib
KPilotLocalLink Class Reference
#include <kpilotlocallink.h>
Inheritance diagram for KPilotLocalLink:

Detailed Description
Implementation of the device link for file-system backed (ie.local, fake) devices. Uses a directory specified in the reset() call to serve databases.
Definition at line 40 of file kpilotlocallink.h.
Public Slots | |
void | ready () |
Public Member Functions | |
KPilotLocalLink (QObject *parent=0L, const char *name=0L) | |
virtual | ~KPilotLocalLink () |
virtual QString | statusString () const |
virtual bool | isConnected () const |
virtual void | reset (const QString &) |
virtual void | close () |
virtual void | reset () |
virtual bool | tickle () |
virtual const KPilotCard * | getCardInfo (int card) |
virtual void | endOfSync () |
virtual void | finishSync () |
virtual int | openConduit () |
virtual int | getNextDatabase (int index, struct DBInfo *) |
virtual int | findDatabase (const char *name, struct DBInfo *, int index=0, unsigned long type=0, unsigned long creator=0) |
virtual bool | retrieveDatabase (const QString &path, struct DBInfo *db) |
virtual DBInfoList | getDBList (int cardno=0, int flags=dlpDBListRAM) |
virtual PilotDatabase * | database (const QString &name) |
Protected Member Functions | |
virtual bool | installFile (const QString &, const bool deleteFile) |
virtual void | addSyncLogEntryImpl (const QString &s) |
virtual int | pilotSocket () const |
unsigned int | findAvailableDatabases (Private &, const QString &path) |
Protected Attributes | |
bool | fReady |
QString | fPath |
Private * | d |
Member Function Documentation
QString KPilotLocalLink::statusString | ( | ) | const [virtual] |
Provides a human-readable status string.
Implements KPilotLink.
Definition at line 1166 of file kpilotlink.cc.
bool KPilotLocalLink::isConnected | ( | ) | const [virtual] |
True if HotSync has been started but not finished yet (ie.
the physical Pilot is waiting for sync commands)
Implements KPilotLink.
Definition at line 1171 of file kpilotlink.cc.
void KPilotLocalLink::reset | ( | const QString & | ) | [virtual] |
Return the device link to the Init state and try connecting to the given device path (if it's non-empty).
What the path means depends on the kind of link we're instantiating.
- See also:
- reset()
Implements KPilotLink.
Definition at line 1176 of file kpilotlink.cc.
void KPilotLocalLink::close | ( | ) | [virtual] |
Release all resources, including the master pilot socket, timers, notifiers, etc.
Implements KPilotLink.
Definition at line 1202 of file kpilotlink.cc.
void KPilotLocalLink::reset | ( | ) | [virtual] |
Assuming things have been set up at least once already by a call to reset() with parameters, use this slot to re-start with the same settings.
Implements KPilotLink.
Definition at line 1183 of file kpilotlink.cc.
bool KPilotLocalLink::tickle | ( | ) | [virtual] |
Tickle the underlying device exactly once.
Implements KPilotLink.
Definition at line 1207 of file kpilotlink.cc.
const KPilotCard * KPilotLocalLink::getCardInfo | ( | int | card | ) | [virtual] |
Retrieve information about the data card card
; I don't think that any pilot supports card numbers other than 0.
Non-device links return something fake.
This function may return NULL (non-device links or on error).
- Note:
- Ownership of the KPilotCard object is given to the caller, who must delete it.
Implements KPilotLink.
Definition at line 1212 of file kpilotlink.cc.
void KPilotLocalLink::endOfSync | ( | ) | [virtual] |
End the sync in a gracuful manner.
Implements KPilotLink.
Definition at line 1217 of file kpilotlink.cc.
void KPilotLocalLink::finishSync | ( | ) | [virtual] |
End the sync in a graceful manner and update the last-sync time and user information on the handheld.
Implements KPilotLink.
Definition at line 1221 of file kpilotlink.cc.
int KPilotLocalLink::openConduit | ( | ) | [virtual] |
Notify the Pilot user that a conduit is running now.
On real devices, this prints out (on screen) which database is now opened; useful for progress reporting.
- Returns:
- -1 on error
- Note:
- the default implementation returns 0
Reimplemented from KPilotLink.
Definition at line 1225 of file kpilotlink.cc.
int KPilotLocalLink::getNextDatabase | ( | int | index, | |
struct DBInfo * | ||||
) | [virtual] |
Fill the DBInfo structure db
with information about the next database (in some ordering) counting from index
.
- Returns:
- < 0 on error
Implements KPilotLink.
Definition at line 1232 of file kpilotlink.cc.
int KPilotLocalLink::findDatabase | ( | const char * | name, | |
struct DBInfo * | , | |||
int | index = 0 , |
|||
unsigned long | type = 0 , |
|||
unsigned long | creator = 0 | |||
) | [virtual] |
Find a database with the given name
(and optionally, type type
and creator ID (from pi_mktag) creator
, on searching from index index
on the handheld.
Fills in the DBInfo structure if found, returns < 0 on error.
Implements KPilotLink.
Definition at line 1254 of file kpilotlink.cc.
bool KPilotLocalLink::retrieveDatabase | ( | const QString & | path, | |
struct DBInfo * | db | |||
) | [virtual] |
Retrieve the database indicated by DBInfo *db
into the local file path
.
This copies all the data, and you can create a PilotLocalDatabase from the resulting path
.
- Returns:
true
on success
Implements KPilotLink.
Definition at line 1329 of file kpilotlink.cc.
DBInfoList KPilotLocalLink::getDBList | ( | int | cardno = 0 , |
|
int | flags = dlpDBListRAM | |||
) | [virtual] |
Returns a list of DBInfo structures describing all the databases available on the link (ie.
device) with the given card number cardno
and flags flags
. No known handheld uses a cardno other than 0; use flags to indicate what kind of databases to fetch -- dlpDBListRAM
or dlpDBListROM
.
- Returns:
- list of DBInfo objects, one for each database
- Note:
- ownership of the DBInfo objects is passed to the caller, who must delete the objects.
Implements KPilotLink.
Definition at line 1373 of file kpilotlink.cc.
PilotDatabase * KPilotLocalLink::database | ( | const QString & | name | ) | [virtual] |
Return a database object for manipulating the database with name name
on the link.
This database may be local or remote, depending on the kind of link in use.
- Returns:
- pointer to database object, or 0 on error.
- Note:
- ownership of the database object is given to the caller, who must delete the object in time.
Implements KPilotLink.
Definition at line 1386 of file kpilotlink.cc.
bool KPilotLocalLink::installFile | ( | const QString & | , | |
const bool | deleteFile | |||
) | [protected, virtual] |
Install a single file onto the device link.
Full pathname f
is used; in addition, if deleteFile
is true remove the source file. Returns true
if the install succeeded.
The default
Implements KPilotLink.
Definition at line 1302 of file kpilotlink.cc.
void KPilotLocalLink::addSyncLogEntryImpl | ( | const QString & | s | ) | [protected, virtual] |
Actually write an entry to the device link.
The message s
is guaranteed to be non-Null.
Implements KPilotLink.
Definition at line 1296 of file kpilotlink.cc.
virtual int KPilotLocalLink::pilotSocket | ( | ) | const [inline, protected, virtual] |
Returns a file handle for raw operations.
Not recommended. On links with no physical device backing, returns -1.
- Note:
- the default implementation returns -1
Reimplemented from KPilotLink.
Definition at line 70 of file kpilotlocallink.h.
The documentation for this class was generated from the following files: