class rfsv

Public Types

• enum seek_mode { PSI_SEEK_SET = 1, PSI_SEEK_CUR = 2, PSI_SEEK_END = 3 }
• enum open_flags { PSI_O_RDONLY = 0000, PSI_O_WRONLY = 0001, PSI_O_RDWR = 0002 }
• enum open_mode { PSI_O_CREAT = 00100, PSI_O_EXCL = 00200, PSI_O_TRUNC = 01000, PSI_O_APPEND = 02000, PSI_O_SHARE = 04000 }
• enum errs { E_PSI_GEN_NONE = 0, E_PSI_GEN_FAIL = -1, E_PSI_GEN_ARG = -2, E_PSI_GEN_OS = -3, E_PSI_GEN_NSUP = -4, E_PSI_GEN_UNDER = -5, E_PSI_GEN_OVER = -6, E_PSI_GEN_RANGE = -7, E_PSI_GEN_DIVIDE = -8, E_PSI_GEN_INUSE = -9, E_PSI_GEN_NOMEMORY = - 10, E_PSI_GEN_NOSEGMENTS = -11, E_PSI_GEN_NOSEM = -12, E_PSI_GEN_NOPROC = -13, E_PSI_GEN_OPEN = -14, E_PSI_GEN_NOTOPEN = -15, E_PSI_GEN_IMAGE = -16, E_PSI_GEN_RECEIVER = -17, E_PSI_GEN_DEVICE = -18, E_PSI_GEN_FSYS = -19, E_PSI_GEN_START = -20, E_PSI_GEN_NOFONT = -21, E_PSI_GEN_TOOWIDE = -22, E_PSI_GEN_TOOMANY = -23, E_PSI_FILE_EXIST = -32, E_PSI_FILE_NXIST = -33, E_PSI_FILE_WRITE = -34, E_PSI_FILE_READ = -35, E_PSI_FILE_EOF = -36, E_PSI_FILE_FULL = -37, E_PSI_FILE_NAME = -38, E_PSI_FILE_ACCESS = -39, E_PSI_FILE_LOCKED = -40, E_PSI_FILE_DEVICE = -41, E_PSI_FILE_DIR = -42, E_PSI_FILE_RECORD = -43, E_PSI_FILE_RDONLY = -44, E_PSI_FILE_INV = -45, E_PSI_FILE_PENDING = -46, E_PSI_FILE_VOLUME = -47, E_PSI_FILE_CANCEL = -48, E_PSI_FILE_ALLOC = -49, E_PSI_FILE_DISC = -50, E_PSI_FILE_CONNECT = -51, E_PSI_FILE_RETRAN = -52, E_PSI_FILE_LINE = -53, E_PSI_FILE_INACT = -54, E_PSI_FILE_PARITY = -55, E_PSI_FILE_FRAME = -56, E_PSI_FILE_OVERRUN = -57, E_PSI_MDM_CONFAIL = -58, E_PSI_MDM_BUSY = -59, E_PSI_MDM_NOANS = -60, E_PSI_MDM_BLACKLIST = -61, E_PSI_FILE_NOTREADY = -62, E_PSI_FILE_UNKNOWN = -63, E_PSI_FILE_DIRFULL = -64, E_PSI_FILE_PROTECT = -65, E_PSI_FILE_CORRUPT = -66, E_PSI_FILE_ABORT = -67, E_PSI_FILE_ERASE = -68, E_PSI_FILE_INVALID = -69, E_PSI_GEN_POWER = -100, E_PSI_FILE_TOOBIG = -101, E_PSI_GEN_DESCR = -102, E_PSI_GEN_LIB = -103, E_PSI_FILE_NDISC = -104, E_PSI_FILE_DRIVER = -105, E_PSI_FILE_COMPLETION = -106, E_PSI_GEN_BUSY = -107, E_PSI_GEN_TERMINATED = -108, E_PSI_GEN_DIED = -109, E_PSI_FILE_HANDLE = -110, E_PSI_NOT_SIBO = -200, E_PSI_INTERNAL = -201 }
• enum file_attribs { PSI_A_RDONLY = 0x0001, PSI_A_HIDDEN = 0x0002, PSI_A_SYSTEM = 0x0004, PSI_A_DIR = 0x0008, PSI_A_ARCHIVE = 0x0010, PSI_A_VOLUME = 0x0020, PSI_A_NORMAL = 0x0040, PSI_A_TEMP = 0x0080, PSI_A_COMPRESSED = 0x0100, PSI_A_READ = 0x0200, PSI_A_EXEC = 0x0400, PSI_A_STREAM = 0x0800, PSI_A_TEXT = 0x1000 }

Public Methods

• virtual  ~rfsv ()
• void  reset ()
• void  reconnect ()
• Enum  getStatus ()
• virtual Enum  fopen (const u_int32_t attr, const char * const name, u_int32_t &handle)
• virtual Enum  mktemp (u_int32_t &handle, std::string &name)
• virtual Enum  fcreatefile (const u_int32_t attr, const char * const name, u_int32_t &handle)
• virtual Enum  freplacefile (const u_int32_t attr, const char * const name, u_int32_t &handle)
• virtual Enum  fclose (const u_int32_t handle)
• virtual Enum  dir (const char * const name, PlpDir &ret)
• virtual Enum  fgetmtime (const char * const name, PsiTime &mtime)
• virtual Enum  fsetmtime (const char * const name, const PsiTime mtime)
• virtual Enum  fgetattr (const char * const name, u_int32_t &attr)
• virtual Enum  fgeteattr (const char * const name, PlpDirent &e)
• virtual Enum  fsetattr (const char * const name, const u_int32_t seta, const u_int32_t unseta)
• virtual Enum  dircount (const char * const name, u_int32_t &count)
• virtual Enum  devlist (u_int32_t &devbits)
• virtual Enum  devinfo (const char drive, PlpDrive &dinfo)
• virtual Enum  fread (const u_int32_t handle, unsigned char * const buffer, const u_int32_t len, u_int32_t &count)
• virtual Enum  fwrite (const u_int32_t handle, const unsigned char * const buffer, const u_int32_t len, u_int32_t &count)
• virtual Enum  copyFromPsion (const char *from, const char *to, void *, cpCallback_t func)
• virtual Enum<rfsv::errs>  copyFromPsion (const char *from, int fd, cpCallback_t cb)
• virtual Enum  copyToPsion (const char * const from, const char * const to, void *, cpCallback_t func)
• virtual Enum  copyOnPsion (const char * const from, const char * const to, void *, cpCallback_t func)
• virtual Enum  fsetsize (const u_int32_t handle, const u_int32_t size)
• virtual Enum  fseek (const u_int32_t handle, const int32_t offset, const u_int32_t mode, u_int32_t &resultpos)
• virtual Enum  mkdir (const char * const name)
• virtual Enum  rmdir (const char * const name)
• virtual Enum  rename (const char * const oldname, const char * const newname)
• virtual Enum  remove (const char * const name)
• virtual Enum  opendir (const u_int32_t attr, const char * const name, rfsvDirhandle &handle)
• virtual Enum  readdir (rfsvDirhandle &handle, PlpDirent &entry)
• virtual Enum  closedir (rfsvDirhandle &handle)
• virtual Enum  setVolumeName (const char drive, const char * const name)
• std::string  attr2String (const u_int32_t attr)
• virtual u_int32_t  opMode (const u_int32_t mode)
• int  getSpeed ()
• virtual int  getProtocolVersion ()

Public Static Methods

• static std::string  convertSlash (const std::string &name)

Protected Methods

• const char * getConnectName ()

Protected Members

• ppsocket *skt
• Enum status
• int32_t serNum

Detailed Description

Access remote file services of a Psion.

rfsv provides an API for accessing file services of a Psion connected via ncpd. This class defines the interface and a small amount of common constants and methods. The majority of implementation is provided by rfsv32 and rfsv16 , which implement the variations of the protocol for EPOC and SIBO respectively. Usually, the class rfsvfactory is used to instantiate the correct variant depending on the remote machine, currently connected.

The kown modes for seek.

The known modes for file open.

The known modes for file creation.

The known error codes.

The known file attributes

[virtual]

Retrieves the current connection status.

Returns: The status of the connection.

[pure virtual]

Opens a file.

Parameters:

attr	The open mode. Use opMode to convert a combination of open_flags and open_mode to the machine-specific representation.
name	The name of the file to open.
handle	The handle for usage with fread , fwrite , fseek or fclose is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Creates a unique temporary file. The file is opened for reading and writing.

Parameters:

handle	The handle for usage with fread , fwrite , fseek or fclose is returned here.
name	The name of the temporary file is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Creates a named file.

Parameters:

attr	The open mode. Use opMode to convert a combination of open_flags and open_mode to the machine-specific representation.
name	The name of the file to create.
handle	The handle for usage with fread , fwrite , fseek or fclose is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Creates an named file, overwriting an existing file.

Parameters:

attr	The open mode. Use opMode to convert a combination of open_flags and open_mode to the machine-specific representation.
name	The name of the file to create.
handle	The handle for usage with fread , fwrite , fseek or fclose is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Close a file on the Psion whih was previously opened/created by using fopen , fcreatefile , freplacefile or mktemp .

Parameters:

handle

A valid file handle.

[pure virtual]

Reads a directory on the Psion. The returned STL deque of PlpDirent contains all requested directory entries.

Parameters:

name	The name of the directory
ret	An STL deque of PlpDirent entries.

Returns: A Psion error code (One of enum rfsv::errs ).

[pure virtual]

Retrieves the modification time of a file on the Psion.

Parameters:

name	Name of the file.
mtime	Modification time is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Sets the modification time of a file on the Psion.

Parameters:

name	Name of the file whose modification time should be set.
mtime	The desired modification time.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Retrieves attributes of a file on the Psion.

Parameters:

name	Name of the file whose attributes ar to be retrieved.
attr	The file's attributes are returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Retrieves attributes, size and modification time of a file on the Psion.

Parameters:

name	The name of the file.
e	PlpDirent object, filled with the information on return.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Counts number of entries in a directory.

Parameters:

name	The directory whose entries are to be counted.
count	The number of entries is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Retrieves available drives on the Psion. devbits On return, for every exiting drive, a bit is set in this variable. The lowest bit represents drive A:.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Retrieves details about a drive.

Parameters:

drive	The drive character of the drive to get details from (e.g: 'C', 'D' etc.). (0 represents A:, 1 is B: and so on ...)
dinfo	A PlpDrive object which is filled with the drive's information upon return.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Reads from a file on the Psion.

Parameters:

handle	Handle of the file to read from.
buffer	The area where to store the data read.
len	The number of bytes to read.
count	The number of bytes actually read is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Write to a file on the Psion.

Parameters:

handle	Handle of the file to read from.
buffer	The area to be written.
len	The number of bytes to write.
count	The number of bytes actually written is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Copies a file from the Psion to the local machine.

Parameters:

from	Name of the file on the Psion to be copied.
to	Name of the destination file on the local machine.
func	Pointer to a function which gets called on every read. This function can be used to show some progress etc. May be set to NULL, where no callback is performed. If the callback function returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Copies a file from the Psion to the local machine.

[pure virtual]

Copies a file from local machine to the Psion.

Parameters:

from	Name of the file on the local machine to be copied.
to	Name of the destination file on the Psion.
func	Pointer to a function which gets called on every read. This function can be used to show some progress etc. May be set to NULL, where no callback is performed. If the callback function returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Copies a file from the Psion to the Psion. On the EPOC variants, this runs much faster than reading data from the Psion and then writing it back to the Psion, since data transfer is handled locally on the Psion.

Parameters:

from	Name of the file to be copied.
to	Name of the destination file.
func	Pointer to a function which gets called on every read. This function can be used to show some progress etc. May be set to NULL, where no callback is performed. If the callback function returns 0, the operation is aborted and E_PSI_FILE_CANCEL is returned.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Resizes an open file on the Psion. If the new size is greater than the file's current size, the contents of the added data is undefined. If The new size is smaller, the file is truncated.

Parameters:

handle	Handle of the file to be resized.
size	New size for that file.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Sets the current file position of a file on the Psion.

Parameters:

handle	The file handle.
offset	Position to be seeked to.
mode	The mode for seeking.
resultpos	The final file position after seeking is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Creates a directory on the Psion.

Parameters:

name	Name of the directory to be created.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Removes a directory on the Psion.

Parameters:

name	Name of the directory to be removed.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Renames a file on the Psion.

Parameters:

oldname	Name of the file to be renamed.
newname	New Name for that file.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Removes a file on the Psion.

Parameters:

name	Name of the file to be removed.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Open a directory for reading with readdir.

Parameters:

attr	A combination of PSI_A_.. flags, representing the desired types of entries to be returned when calling readdir .
name	The name of the directory
handle	A handle to be used with readdir and closedir .

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Read directory entries. This method reads entries of a directory, previously opened with opendir .

Parameters:

handle	A handle, obtained by calling opendir .
entry	The entry information is returned here.

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Close a directory, previously opened with opendir.

Parameters:

handle

A handle, obtained by calling opendir .

Returns: A Psion error code (One of enum errs ).

[pure virtual]

Set the name of a Psion Volume (Drive).

Parameters:

drive	The drive character of the Volume, whose name should be set.
name	The new name for that drive.

Returns: A Psion error code (One of enum errs ).

Converts a file attribute rfsv::file_attribs to human readable format, usable for showing them in directory listings. The first 7 characters are common to all machine types:

 	Char Nr. Value
 	0        'd' if a directory,                     '-' otherwise.
 	1        'r' if file is readable,                '-' otherwise.
 	2        'w' if file is writeable,               '-' otherwise.
 	3        'h' if file is hidden,                  '-' otherwise.
 	4        's' if file is a system file,           '-' otherwise.
 	5        'a' if file is modified (archive flag), '-' otherwise.
 	6        'v' if file is a volume name,           '-' otherwise.

The rest (3 characters) are machine specific:

 	Char Nr. EPOC Value          SIBO Value
 	7        'n' if normal,      'x' if executable, '-' otherwise.
 	8        't' if temporary,   'b' if a stream,   '-' otherwise.
 	8        'c' if compressed,  't' if a textfile, '-' otherwise.

Parameters:

attr	the generic file attribute.

Returns: Pointer to static textual representation of file attributes.

[pure virtual]

Converts an open-mode (A combination of the PSI_O_ constants.) from generic representation to the machine-specific representation.

Parameters:

mode	The generic open mode.

Returns: The machine specific representation for use with fopen , fcreatefile and @freplacefile.

[static]

Utility method, converts '/' to '\'.

Retrieve speed of serial link.

Returns: The speed of the serial link in baud or -1 on error.

[pure virtual]

Retrieves the protocol version.

Returns: Either 3 or 5 representing Series 3 (SIBO) or Series 5 (EPOC)

[protected]

Retrieves the PLP protocol name. Mainly internal use.

Returns: The connection name always "SYS$RFSV"

[protected]

[protected]

[protected]