diff options
Diffstat (limited to 'lib/rpcsfactory.h')
-rw-r--r-- | lib/rpcsfactory.h | 28 |
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 |