GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > ZLIB / V2-1-0

Constituent: zlib_file_inflate     Tag: rad750


Interface   Compound List   File List   Compound Members   File Members  

ZLIB_file_inflate.c File Reference

File de-compression utilities using the ZLIB decoder. More...

#include "stdlib.h"
#include "unistd.h"
#include "fcntl.h"
#include "errno.h"
#include "sys/types.h"
#include "sys/stat.h"
#include "ZLIB/zlib.h"
#include "ZLIB/ZLIB_file_inflate.h"
#include "PBS/BSWP.h"
#include "PBS/MBA.h"
#include "MSG/MSG_pubdefs.h"

Include dependency graph for ZLIB_file_inflate.c:

Include dependency graph

Functions

unsigned int ZLIB_fileInflateError (int errCode, const char *func, const char *msg)
void * ZLIB_fileInflateAlloc (void *opaque, unsigned int numItems, unsigned int size)
void ZLIB_fileInflateFree (void *opaque, void *address)
unsigned int ZLIB_fileInflateToFile (int in, int out, unsigned int bufSize)
 Inflate a file into an output file.

unsigned int ZLIB_fileInflateToMem (int in, void *out, unsigned int outSize, unsigned int bufSize)
 Inflate a memory region into an output file.

unsigned int ZLIB_fileInflateSizeof (int file, unsigned int *size)
 Determine amount of memory for file inflation.


Detailed Description

File de-compression utilities using the ZLIB decoder.

Author:
D.L. Wood

Function Documentation

void * ZLIB_fileInflateAlloc void *  opaque,
unsigned int  numItems,
unsigned int  size
[static]
 

Memory allocation callback for ZLIB stream.

Parameters:
opaque Ignored.
numItems The number of items to allocate.
size The size in bytes of each item.
Returns:
A pointer to the allocated memory, or NULL on failure.

unsigned int ZLIB_fileInflateError int  errCode,
const char *  func,
const char *  msg
[static]
 

This function translates ZLIB native error codes into MSG codes.

Parameters:
errCode The ZLIB error code.
func The name of the function in which the error occurred.
msg A message to print out in the MSG output.
Returns:
The MSG code value.

void ZLIB_fileInflateFree void *  opaque,
void *  address
[static]
 

Memory release callback for ZLIB stream.

Parameters:
opaque Ignored.
address Pointer to memory to free.
Returns:
A pointer to the allocated memory, or NULL on failure.

unsigned int ZLIB_fileInflateSizeof int  file,
unsigned int *  size
 

Determine amount of memory for file inflation.

This function returns the size in bytes required for the output buffer to inflate a ZLIB file.

Parameters:
file The file descriptor.
size Holds memory size upon return.
Returns:
A ZLIB MSG code.

unsigned int ZLIB_fileInflateToFile int  in,
int  out,
unsigned int  bufSize
 

Inflate a file into an output file.

This function uses the ZLIB memory to memory inflation library to inflate an input file to an output file. Temporary buffer storage of the streams can be minimized by providing a small value for bufSize. The in and out file handles must already have been opened. This function will not close the file handles, and may leave the file pointers at an offset within the file. The in file offset should point to the place where the compression record starts within the input file.

Parameters:
in The input file handle.
out The inflated output file handle.
bufSize The size in bytes to allocate for stream buffering.
Returns:
A ZLIB MSG code.

Here is the call graph for this function:

unsigned int ZLIB_fileInflateToMem int  in,
void *  out,
unsigned int  outSize,
unsigned int  bufSize
 

Inflate a memory region into an output file.

This function uses the ZLIB memory to memory inflation library to inflate an input file to an output memory buffer. Temporary buffer storage of the streams is minimized. The in file handle must already have been opened. This function will not close the file handle, and may leave the file pointer at an offset within the file. The in file offset should point to the place where the compression record starts within the input file.

Parameters:
in The input file handle.
out The inflated output memory buffer.
outSize The size in bytes of the out buffer.
bufSize The size in bytes to allocate for stream buffering.
Returns:
A ZLIB MSG code.

Here is the call graph for this function:


Generated on Fri May 28 02:07:52 2004 by doxygen 1.3.3