aboutsummaryrefslogtreecommitdiffstats
path: root/lib/rpcsfactory.h
diff options
context:
space:
mode:
authorFritz Elfert <felfert@to.com>2000-07-31 03:12:38 +0000
committerFritz Elfert <felfert@to.com>2000-07-31 03:12:38 +0000
commit7fb94ed43a814788cda019c1e77314abc1626339 (patch)
tree50b86a44e2809e6fbcdcd080f2a2dc4dbc37042e /lib/rpcsfactory.h
parentfbb17061d3c622f0786a5d9ad41e8ccd95ef706c (diff)
downloadplptools-7fb94ed43a814788cda019c1e77314abc1626339.tar.gz
plptools-7fb94ed43a814788cda019c1e77314abc1626339.tar.bz2
plptools-7fb94ed43a814788cda019c1e77314abc1626339.zip
Applied mjg-0.6 patch.
Started adding kdoc compliant documentation comments. Added PsiTime
Diffstat (limited to 'lib/rpcsfactory.h')
-rw-r--r--lib/rpcsfactory.h28
1 files changed, 25 insertions, 3 deletions
diff --git a/lib/rpcsfactory.h b/lib/rpcsfactory.h
index 17a2719..feffaee 100644
--- a/lib/rpcsfactory.h
+++ b/lib/rpcsfactory.h
@@ -5,15 +5,37 @@
class ppsocket;
+/**
+ * A factory for automatically instantiating the correct protocol
+ * variant depending on the connected Psion.
+ */
class rpcsfactory {
public:
+ /**
+ * Constructs a rpcsfactory.
+ *
+ * @param skt The socket to be used for connecting
+ * to the ncpd daemon.
+ */
rpcsfactory(ppsocket * skt);
- virtual rpcs * create(bool);
+
+ /**
+ * Creates a new rpsc instance.
+ *
+ * @param reconnect Set to true, if automatic reconnect
+ * should be performed on failure.
+ *
+ * @returns A pointer to a newly created rpcs instance or
+ * NULL on failure.
+ */
+ virtual rpcs * create(bool reconnect);
private:
- // Vars
+ /**
+ * The socket to be used for connecting to the
+ * ncpd daemon.
+ */
ppsocket *skt;
- int serNum;
};
#endif