kpilot
NullConduit Class Reference
The conduit Null does nothing. More...
#include <null-conduit.h>
Public Member Functions | |
| NullConduit (KPilotLink *, const char *name=0L, const QStringList &args=QStringList()) | |
| virtual | ~NullConduit () |
Protected Member Functions | |
| virtual bool | exec () |
Protected Attributes | |
| PilotDatabase * | fDatabase |
| bool | fFailImmediately |
Detailed Description
The conduit Null does nothing.Almost nothing, anyway. It writes a single log message to the sync log and then completes successfully. For debugging purposes it can also simulate failure, but that is a very specialized case available only programmatically.
Definition at line 45 of file null-conduit.h.
Constructor & Destructor Documentation
| NullConduit::NullConduit | ( | KPilotLink * | d, | |
| const char * | name = 0L, |
|||
| const QStringList & | args = QStringList() | |||
| ) |
Constructor.
Special case is if contains --fail as an argument to the conduit, then the conduit will fail instead of trivially succeeding.
Definition at line 55 of file null-conduit.cc.
| NullConduit::~NullConduit | ( | ) | [virtual] |
Definition at line 66 of file null-conduit.cc.
Member Function Documentation
| bool NullConduit::exec | ( | ) | [protected, virtual] |
This function starts the actual processing done by the conduit.
It should return false if the processing cannot be initiated, f.ex. because some parameters were not set or a needed library is missing. This will be reported to the user. It should return true if processing is started normally. If processing starts normally, it is the _conduit's_ responsibility to eventually emit syncDone(); if processing does not start normally (ie. exec() returns false) then the environment will deal with syncDone().
Implements SyncAction.
Definition at line 72 of file null-conduit.cc.
Member Data Documentation
PilotDatabase* NullConduit::fDatabase [protected] |
bool NullConduit::fFailImmediately [protected] |
Definition at line 62 of file null-conduit.h.
The documentation for this class was generated from the following files:
