TekFileBZ2Binary Class Reference

Inheritance diagram for TekFileBZ2Binary:

Inheritance graph
[legend]
Collaboration diagram for TekFileBZ2Binary:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Detailed Description

This is the bare-bones final interface to TekFileBZ2.

This interface is FINAL.

Author:
Kevin McBride

Definition at line 37 of file tekfilebz2binary.h.


Constructor & Destructor Documentation

TekFileBZ2Binary TekFileBZ2Binary  ) 
 

Instantizer.

Definition at line 57 of file TekFileBZ2Binary.cpp.

~TekFileBZ2Binary  ) 
 

Destructor.

Definition at line 81 of file TekFileBZ2Binary.cpp.

References Close().

Here is the call graph for this function:


Member Function Documentation

TEKERR Close  )  [virtual]
 

Closes the file.

Implements TekFileBZ2.

Definition at line 587 of file TekFileBZ2Binary.cpp.

References i64::i64_a, and i64::i64_b.

Referenced by put_FILE(), and ~TekFileBZ2Binary().

TEKERR CloseStream  )  [virtual]
 

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

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

Implements TekFileBZ2.

Definition at line 332 of file TekFileBZ2Binary.cpp.

References i64::i64_a, and i64::i64_b.

Referenced by put_FILE().

TEKERR Flush  )  [virtual]
 

This function is not implemented.

Implements TekFileBZ2.

Definition at line 714 of file TekFileBZ2Binary.cpp.

TEKERR get_BlockSize unsigned int *  RetVal  )  [virtual]
 

Retrieves the block size to use for writing.

Implements TekFileBZ2.

Definition at line 309 of file TekFileBZ2Binary.cpp.

TEKERR get_BytesIn uint64_t *  RetVal  )  [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.

Implements TekFileBZ2.

Definition at line 102 of file TekFileBZ2Binary.cpp.

TEKERR get_BytesOut uint64_t *  RetVal  )  [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.

Implements TekFileBZ2.

Definition at line 125 of file TekFileBZ2Binary.cpp.

TEKERR get_FILE FILE **  FileDescriptor  )  [virtual]
 

Obtains the handle used to access the open file.

Implements TekFileBZ2.

Definition at line 451 of file TekFileBZ2Binary.cpp.

TEKERR get_Filename uchar_t **  Name  )  [virtual]
 

Obtains the filename in the form of a uchar.

Implements TekFileBZ2.

Definition at line 474 of file TekFileBZ2Binary.cpp.

TEKERR get_Location unsigned long *  Location  )  [virtual]
 

Retrieves the location.

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

Implements TekFileBZ2.

Definition at line 1073 of file TekFileBZ2Binary.cpp.

TEKERR get_Location64 uint64_t *  Location  )  [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 TekFileBZ2.

Definition at line 1089 of file TekFileBZ2Binary.cpp.

TEKERR get_Mode TekFileMode *  ModeID  )  [virtual]
 

Retrieves the mode currently set.

Implements TekFileBZ2.

Definition at line 661 of file TekFileBZ2Binary.cpp.

TEKERR get_Type TekFileType *  FileTypePointer  )  [virtual]
 

Gets the file type.

Implements TekFileBZ2.

Definition at line 569 of file TekFileBZ2Binary.cpp.

TEKERR get_UseLessMemory unsigned int *  RetVal  )  [virtual]
 

Retrieves the UseLessMemory flag.

Implements TekFileBZ2.

Definition at line 175 of file TekFileBZ2Binary.cpp.

TEKERR get_Verbosity unsigned int *  RetVal  )  [virtual]
 

Retrieves the current verbosity value.

Implements TekFileBZ2.

Definition at line 265 of file TekFileBZ2Binary.cpp.

TEKERR get_WorkFactor unsigned int *  RetVal  )  [virtual]
 

Retrieves the work factor number.

Implements TekFileBZ2.

Definition at line 223 of file TekFileBZ2Binary.cpp.

TEKERR Open  )  [virtual]
 

Opens the file and a BZIP2 stream.

Implements TekFileBZ2.

Definition at line 725 of file TekFileBZ2Binary.cpp.

TEKERR Open64  )  [virtual]
 

Opens the file and a BZIP2 stream using 64 bit semantics.

Implements TekFileBZ2.

Definition at line 811 of file TekFileBZ2Binary.cpp.

TEKERR OpenStream  )  [virtual]
 

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

Implements TekFileBZ2.

Definition at line 395 of file TekFileBZ2Binary.cpp.

TEKERR put_BlockSize unsigned int  NewVal  )  [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.

Implements TekFileBZ2.

Definition at line 288 of file TekFileBZ2Binary.cpp.

TEKERR put_FILE FILE *  FileDescriptor  )  [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
TekFileBZ2Binary::get_FILE()! Utilizing the descriptor in a direct fashion after a
successful call to put_FILE() will result in undefined results!!!!!

Implements TekFileBZ2.

Definition at line 510 of file TekFileBZ2Binary.cpp.

References Close(), and CloseStream().

Here is the call graph for this function:

TEKERR put_Filename uchar_t Name  )  [virtual]
 

Sets the filename to access.

Implements TekFileBZ2.

Definition at line 537 of file TekFileBZ2Binary.cpp.

References _uchar_t::uchar_t_ascii, and _uchar_t::uchar_t_asciilen.

TEKERR put_Mode TekFileMode  ModeID  )  [virtual]
 

Retrieves the mode currently set.

NOTE: This function will fail if a descriptor is open!

Implements TekFileBZ2.

Definition at line 686 of file TekFileBZ2Binary.cpp.

TEKERR put_UseLessMemory unsigned int  NewVal  )  [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.

Implements TekFileBZ2.

Definition at line 148 of file TekFileBZ2Binary.cpp.

TEKERR put_Verbosity unsigned int  NewVal  )  [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.

Implements TekFileBZ2.

Definition at line 246 of file TekFileBZ2Binary.cpp.

TEKERR put_WorkFactor unsigned int  NewVal  )  [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.

Implements TekFileBZ2.

Definition at line 204 of file TekFileBZ2Binary.cpp.

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

Read from the file.

Implements TekFileBZ2.

Definition at line 908 of file TekFileBZ2Binary.cpp.

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

Read from the file using 64 bit semantics.

Implements TekFileBZ2.

Definition at line 897 of file TekFileBZ2Binary.cpp.

TEKERR Seek TekFileSeek  SeekWhere,
signed long  NewLocation
[virtual]
 

This is not implemented.

Implements TekFileBZ2.

Definition at line 1002 of file TekFileBZ2Binary.cpp.

TEKERR Seek64 TekFileSeek  SeekWhere,
int64_t  NewLocation
[virtual]
 

This is not implemented.

Implements TekFileBZ2.

Definition at line 991 of file TekFileBZ2Binary.cpp.

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

Write to the file.

Implements TekFileBZ2.

Definition at line 1024 of file TekFileBZ2Binary.cpp.

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

Write to the file using 64 bit semantics.

Implements TekFileBZ2.

Definition at line 1013 of file TekFileBZ2Binary.cpp.


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