TekFileBZ2 Class Reference

Inheritance diagram for TekFileBZ2:

Inheritance graph
[legend]
Collaboration diagram for TekFileBZ2:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TekFileBZ2 ()
 ~TekFileBZ2 ()
virtual TEKERR get_BytesIn (uint64_t *RetVal)=0
virtual TEKERR get_BytesOut (uint64_t *RetVal)=0
virtual TEKERR put_UseLessMemory (unsigned int NewVal)=0
virtual TEKERR get_UseLessMemory (unsigned int *RetVal)=0
virtual TEKERR put_WorkFactor (unsigned int NewVal)=0
virtual TEKERR get_WorkFactor (unsigned int *RetVal)=0
virtual TEKERR put_Verbosity (unsigned int NewVal)=0
virtual TEKERR get_Verbosity (unsigned int *RetVal)=0
virtual TEKERR put_BlockSize (unsigned int NewVal)=0
virtual TEKERR get_BlockSize (unsigned int *RetVal)=0
virtual TEKERR CloseStream ()=0
virtual TEKERR OpenStream ()=0
virtual TEKERR get_FILE (FILE **FileDescriptor)=0
virtual TEKERR get_Filename (uchar_t **Name)=0
virtual TEKERR get_Mode (TekFileMode *ModeID)=0
virtual TEKERR get_Type (TekFileType *FileTypePointer)=0
virtual TEKERR put_FILE (FILE *FileDescriptor)=0
virtual TEKERR put_Filename (uchar_t *Name)=0
virtual TEKERR put_Mode (TekFileMode ModeID)=0
virtual TEKERR Close ()=0
virtual TEKERR Flush ()=0
virtual TEKERR Open ()=0
virtual TEKERR Open64 ()=0
virtual TEKERR Read64 (void *Buffer, uint64_t BytesToRead, uint64_t *BytesRead)=0
virtual TEKERR Read (void *Buffer, unsigned long BytesToRead, unsigned long *BytesRead)=0
virtual TEKERR Seek64 (TekFileSeek SeekWhere, int64_t NewLocation)=0
virtual TEKERR Seek (TekFileSeek SeekWhere, signed long NewLocation)=0
virtual TEKERR Write64 (void *Buffer, uint64_t BytesToWrite, uint64_t *BytesWrote)=0
virtual TEKERR Write (void *Buffer, unsigned long BytesToWrite, unsigned long *BytesWrote)=0
virtual TEKERR get_Location (unsigned long *Location)=0
virtual TEKERR get_Location64 (uint64_t *Location)=0

Detailed Description

This interface defines a standard for accessing bzip2-compressed files

This interface is INHERITABLE.

Author:
Kevin McBride

Definition at line 46 of file tekfilebz2.h.


Constructor & Destructor Documentation

TekFileBZ2 TekFileBZ2  ) 
 

Instantizer.

Definition at line 52 of file TekFileBZ2.cpp.

~TekFileBZ2  ) 
 

Destructor.

Definition at line 60 of file TekFileBZ2.cpp.


Member Function Documentation

TEKERR Close  )  [pure virtual]
 

Closes the file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 309 of file TekFileBZ2.cpp.

TEKERR CloseStream  )  [pure virtual]
 

Tells the BZIP2 library to close the stream currently open for the internally held FILE *

NOTE: TekFileBZ2::Close() should be used instead. TekFileBZ2::CloseStream() will not close the internally held FILE *

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 226 of file TekFileBZ2.cpp.

TEKERR Flush  )  [pure virtual]
 

Flushes the buffer.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 331 of file TekFileBZ2.cpp.

TEKERR get_BlockSize unsigned int *  RetVal  )  [pure virtual]
 

Retrieves the block size to use for writing.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 210 of file TekFileBZ2.cpp.

TEKERR get_BytesIn uint64_t *  RetVal  )  [pure virtual]
 

Retrieves the amount of bytes bzip2 recieved.

NOTE: You will get a TEKERR_UNAVAILABLE if you try calling this function while the BytesIn data is unavailable.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 80 of file TekFileBZ2.cpp.

TEKERR get_BytesOut uint64_t *  RetVal  )  [pure virtual]
 

Retrieves the amount of bytes bzip2 put out.

NOTE: You will get a TEKERR_UNAVAILABLE if you try calling this function while the BytesIn data is unavailable.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 96 of file TekFileBZ2.cpp.

TEKERR get_FILE FILE **  FileDescriptor  )  [pure virtual]
 

Obtains the handle used to access the open file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 249 of file TekFileBZ2.cpp.

TEKERR get_Filename uchar_t **  Name  )  [pure virtual]
 

Obtains the filename in the form of a uchar.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 260 of file TekFileBZ2.cpp.

TEKERR get_Location unsigned long *  Location  )  [pure virtual]
 

Retrieves the location.

CAUTION! This function may not be implemented due to optimization settings, so watch out for TEKERR_NOTIMPL return value.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 446 of file TekFileBZ2.cpp.

TEKERR get_Location64 uint64_t *  Location  )  [pure virtual]
 

Retrieves the location and stores it in a 64-bit variable.

CAUTION! This function may not be implemented due to optimization settings, so watch out for TEKERR_NOTIMPL return value.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 462 of file TekFileBZ2.cpp.

TEKERR get_Mode TekFileMode *  ModeID  )  [pure virtual]
 

Retrieves the mode currently set.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 320 of file TekFileBZ2.cpp.

TEKERR get_Type TekFileType *  FileTypePointer  )  [pure virtual]
 

Gets the file type.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 298 of file TekFileBZ2.cpp.

TEKERR get_UseLessMemory unsigned int *  RetVal  )  [pure virtual]
 

Retrieves the UseLessMemory flag.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 124 of file TekFileBZ2.cpp.

TEKERR get_Verbosity unsigned int *  RetVal  )  [pure virtual]
 

Retrieves the current verbosity value.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 183 of file TekFileBZ2.cpp.

TEKERR get_WorkFactor unsigned int *  RetVal  )  [pure virtual]
 

Retrieves the work factor number.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 155 of file TekFileBZ2.cpp.

TEKERR Open  )  [pure virtual]
 

Open the file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 342 of file TekFileBZ2.cpp.

TEKERR Open64  )  [pure virtual]
 

Open the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 353 of file TekFileBZ2.cpp.

TEKERR OpenStream  )  [pure virtual]
 

Tells the BZIP2 library to open a stream for the internally held FILE *

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 238 of file TekFileBZ2.cpp.

TEKERR put_BlockSize unsigned int  NewVal  )  [pure virtual]
 

Sets the block size to use for writing. Allowed values are 1-9.

NOTE: You will get a TEKERR_ACCESS if you try calling this function while the internally held BZFILE structure is opened.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 199 of file TekFileBZ2.cpp.

TEKERR put_FILE FILE *  FileDescriptor  )  [pure virtual]
 

Sets the handle used to access a file.

WARNING!!!!! DO NOT USE THE FILE DESCRIPTOR YOU PASS IN
TO THIS FUNCTION UNLESS YOU HAVE RE-RETRIEVED IT USING
TekFileBZ2::get_FILE()! Utilizing the descriptor in a direct fashion after a
successful call to put_FILE() will result in undefined results!!!!!

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 276 of file TekFileBZ2.cpp.

TEKERR put_Filename uchar_t Name  )  [pure virtual]
 

Sets the filename to access.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 287 of file TekFileBZ2.cpp.

TEKERR put_Mode TekFileMode  ModeID  )  [pure virtual]
 

Sets the mode used to open the file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 364 of file TekFileBZ2.cpp.

TEKERR put_UseLessMemory unsigned int  NewVal  )  [pure virtual]
 

Sets or resets the UseLessMemory flag.

NOTE: You will get a TEKERR_ACCESS if you try calling this function while the internally held BZFILE structure is opened.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 112 of file TekFileBZ2.cpp.

TEKERR put_Verbosity unsigned int  NewVal  )  [pure virtual]
 

Sets the current verbosity value.

NOTE: You will get a TEKERR_ACCESS if you try calling this function while the internally held BZFILE structure is opened.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 171 of file TekFileBZ2.cpp.

TEKERR put_WorkFactor unsigned int  NewVal  )  [pure virtual]
 

Sets the work factor number.

NOTE: You will get a TEKERR_ACCESS if you try calling this function while the internally held BZFILE structure is opened.

WARNING: It is best that you not set this yourself. The bzip2 library handles this on its own.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 143 of file TekFileBZ2.cpp.

TEKERR Read void *  Buffer,
unsigned long  BytesToRead,
unsigned long *  BytesRead
[pure virtual]
 

Read from the file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 386 of file TekFileBZ2.cpp.

TEKERR Read64 void *  Buffer,
uint64_t  BytesToRead,
uint64_t *  BytesRead
[pure virtual]
 

Read from the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 375 of file TekFileBZ2.cpp.

TEKERR Seek TekFileSeek  SeekWhere,
signed long  NewLocation
[pure virtual]
 

This is not implemented.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 408 of file TekFileBZ2.cpp.

TEKERR Seek64 TekFileSeek  SeekWhere,
int64_t  NewLocation
[pure virtual]
 

This is not implemented.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 397 of file TekFileBZ2.cpp.

TEKERR Write void *  Buffer,
unsigned long  BytesToWrite,
unsigned long *  BytesWrote
[pure virtual]
 

Write to the file.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 430 of file TekFileBZ2.cpp.

TEKERR Write64 void *  Buffer,
uint64_t  BytesToWrite,
uint64_t *  BytesWrote
[pure virtual]
 

Write to the file using 64 bit semantics.

Implements TekFile.

Implemented in TekFileBZ2Binary, and TekFileBZ2ASCII.

Definition at line 419 of file TekFileBZ2.cpp.


The documentation for this class was generated from the following files: SourceForge.net Logo  Technical Library Template Interface Project Page