kpilot/lib
KPilotDeviceLink Class Reference
#include <kpilotdevicelink.h>
Inheritance diagram for KPilotDeviceLink:

Detailed Description
Implementation of the device link class for physical handheld devices, which communicate with the PC using DLP / SLP via the pilot-link library.
Definition at line 40 of file kpilotdevicelink.h.
Public Types | |
enum | LinkStatus { Init, WaitingForDevice, FoundDevice, CreatedSocket, DeviceOpen, AcceptedDevice, SyncDone, PilotLinkError, WorkaroundUSB } |
Public Member Functions | |
KPilotDeviceLink (QObject *parent=0, const char *name=0, const QString &tempDevice=QString::null) | |
virtual | ~KPilotDeviceLink () |
LinkStatus | status () const |
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) |
void | setWorkarounds (bool usb) |
void | setTempDevice (const QString &device) |
Static Public Member Functions | |
static QString | statusString (LinkStatus l) |
Protected Types | |
enum | { OpenMessage = 1, OpenFailMessage = 2 } |
Protected Slots | |
void | openDevice () |
void | acceptDevice () |
Protected Member Functions | |
virtual bool | installFile (const QString &, const bool deleteFile) |
virtual void | addSyncLogEntryImpl (const QString &s) |
virtual int | pilotSocket () const |
bool | open (const QString &device=QString::null) |
void | checkDevice () |
void | shouldPrint (int msgid, const QString &s) |
Protected Attributes | |
int | messages |
int | messagesMask |
Static Protected Attributes | |
static const int | messagesType |
Friends | |
class | PilotSerialDatabase |
Member Enumeration Documentation
|
Some messages are only printed once and are suppressed after that. These are indicated by flag bits in messages. Definition at line 183 of file kpilotdevicelink.h. |
|
The link behaves like a state machine most of the time: it waits for the actual device to become available, and then becomes ready to handle syncing.
Definition at line 66 of file kpilotdevicelink.h. |
Constructor & Destructor Documentation
|
Creates a pilot link that can sync to the pilot. Call reset() on it to start looking for a device. Definition at line 320 of file kpilotlink.cc. |
|
Destructor. This rudely ends the communication with the handheld. Definition at line 343 of file kpilotlink.cc. |
Member Function Documentation
|
Called when the device is opened *and* activity occurs on the device. This indicates the beginning of a hotsync. Definition at line 679 of file kpilotlink.cc. |
|
Actually write an entry to the device link.
The message Implements KPilotLink. Definition at line 851 of file kpilotlink.cc. |
|
Check for device permissions and existence, emitting warnings for weird situations. This is primarily intended to inform the user. Definition at line 437 of file kpilotlink.cc. |
|
Release all resources, including the master pilot socket, timers, notifiers, etc.
Implements KPilotLink. Definition at line 358 of file kpilotlink.cc. |
|
Return a database object for manipulating the database with name This database may be local or remote, depending on the kind of link in use.
Implements KPilotLink. Definition at line 1093 of file kpilotlink.cc. |
|
End the sync in a gracuful manner.
Implements KPilotLink. Definition at line 948 of file kpilotlink.cc. |
|
Find a database with the given Fills in the DBInfo structure if found, returns < 0 on error. Implements KPilotLink. Definition at line 984 of file kpilotlink.cc. |
|
End the sync in a graceful manner and update the last-sync time and user information on the handheld.
Implements KPilotLink. Definition at line 955 of file kpilotlink.cc. |
|
Retrieve information about the data card Non-device links return something fake. This function may return NULL (non-device links or on error).
Implements KPilotLink. Definition at line 1066 of file kpilotlink.cc. |
|
Returns a list of DBInfo structures describing all the databases available on the link (ie.
device) with the given card number
Implements KPilotLink. Definition at line 1033 of file kpilotlink.cc. |
|
Fill the DBInfo structure
Implements KPilotLink. Definition at line 970 of file kpilotlink.cc. |
|
Install a single file onto the device link.
Full pathname The default Implements KPilotLink. Definition at line 857 of file kpilotlink.cc. |
|
True if HotSync has been started but not finished yet (ie. the physical Pilot is waiting for sync commands) Implements KPilotLink. Definition at line 352 of file kpilotlink.cc. |
|
Does the low-level opening of the device and handles the pilot-link library initialisation.
Definition at line 507 of file kpilotlink.cc. |
|
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.
Reimplemented from KPilotLink. Definition at line 899 of file kpilotlink.cc. |
|
Attempt to open the device. Called regularly to check if the device exists (to handle USB-style devices). Definition at line 471 of file kpilotlink.cc. |
|
Returns a file handle for raw operations. Not recommended. On links with no physical device backing, returns -1.
Reimplemented from KPilotLink. Definition at line 108 of file kpilotdevicelink.h. |
|
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 422 of file kpilotlink.cc. |
|
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.
Implements KPilotLink. Definition at line 391 of file kpilotlink.cc. |
|
Retrieve the database indicated by DBInfo
This copies all the data, and you can create a PilotLocalDatabase from the resulting
Implements KPilotLink. Definition at line 992 of file kpilotlink.cc. |
|
Sets an additional device, which should be tried as fallback. Useful for hotplug enviroments, this device is used once for accepting a connection. Definition at line 465 of file kpilotlink.cc. |
|
Special-cases. Call this after a reset to set device- specific workarounds; the only one currently known is the Zire 31/72 T5 quirk of doing a non-HotSync connect when it's switched on. Definition at line 126 of file kpilotdevicelink.h. |
|
Print a message Printing a message adds it to the messagesMask. Definition at line 1083 of file kpilotlink.cc. |
|
Get the status (state enum) of this link.
Definition at line 81 of file kpilotdevicelink.h. |
|
Provides a human-readable status string.
Implements KPilotLink. Definition at line 943 of file kpilotlink.cc. |
|
Get a human-readable string for the given status
Definition at line 904 of file kpilotlink.cc. |
|
Tickle the underlying device exactly once.
Implements KPilotLink. Definition at line 844 of file kpilotlink.cc. |
Member Data Documentation
|
Initial value: (int)OpenFailMessage Definition at line 186 of file kpilotdevicelink.h. |
The documentation for this class was generated from the following files: