Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members  

FilePlugin Class Reference

#include <FilePlugin.h>

Inheritance diagram for FilePlugin:

Plugin LocalFilePlugin ODBCFilePlugin List of all members.

Public Methods

virtual CoreError create (NumID &fileid)=0
virtual CoreError open (NumID fileid, NumID &of)=0
virtual CoreError remove (NumID fileid)=0
virtual int64_t getLength (NumID fileid)=0
virtual CoreError write (NumID fileid, char *data, int length)=0
virtual CoreError read (NumID fileid, char *data, int length, int &bRead)=0
virtual CoreError close (NumID fileid)=0

Detailed Description

Stores the bitstreams of documents in a repository. This is a virtual class.

Implementations of this class must be thread-safe.

Member Function Documentation

virtual CoreError FilePlugin::close (  NumID    fileid )  [pure virtual]
 

Close newly created or open file.

Parameters:
fileid  the open file to close
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual CoreError FilePlugin::create (  NumID &    fileid )  [pure virtual]
 

Create and store a new file on the fileserver.

Parameters:
fileid  the fileid that was created
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual int64_t FilePlugin::getLength (  NumID    fileid )  [pure virtual]
 

Get the length of an open file.

Parameters:
fileid  the file
Returns:
the length of the file or -1 on error

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual CoreError FilePlugin::open (  NumID    fileid,
NumID &    of
)  [pure virtual]
 

Open and read a file from the fileserver.

Parameters:
fileid  the file that is to be read
of  the reference that receives the open file ID
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual CoreError FilePlugin::read (  NumID    fileid,
char *    data,
int    length,
int &    bRead
)  [pure virtual]
 

Read binary data from file.

Parameters:
fileid  the open file to read from
data  the buffer that receives the data
length  the maximum number of bytes to read
bRead  receives the number of bytes actually read
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual CoreError FilePlugin::remove (  NumID    fileid )  [pure virtual]
 

Remove a file from the fileserver.

Parameters:
fileid  the file to remove
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

virtual CoreError FilePlugin::write (  NumID    fileid,
char *    data,
int    length
)  [pure virtual]
 

Write binary data to new file.

Parameters:
fileid  the newly created file to write to
data  the data to write
length  the length of the data in bytes
Returns:
status code

Implemented in LocalFilePlugin, and ODBCFilePlugin.

The documentation for this class was generated from the following files:
Generated on Wed Feb 18 13:45:56 2004 for strongroom by doxygen1.2.18