HP LoadRunner Protocol SDK Test Run API Reference  12.02
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Macros | Enumerations | Functions
CompressionUtilities.h File Reference

This file contains declarations of compression utilities. More...

Go to the source code of this file.

Enumerations

enum  COMPRESSION_TYPE { GZIP_COMPRESSION_TYPE, DEFLATE_COMPRESSION_TYPE }
 Compression algorithms. More...
 

Functions

void UTILITIES_DECLSPEC CompressBuffer (COMPRESSION_TYPE mCompressionType, const char *mInputBuffer, size_t mInputBufferSize, char *mCompressedBuffer, size_t mCompressedBufferSize, size_t *mCompressedBodyUsedBytes)
 Compresses the input buffer using the specified compression method. More...
 
bool UTILITIES_DECLSPEC DecompressBuffer (COMPRESSION_TYPE mCompressionType, const char *mInputBuffer, size_t mInputBufferSize, char *mDecompressedBuffer, size_t mDecompressedBufferSize, size_t *mDecompressedBodyUsedBytes, size_t *mInputBufferUsedBytes)
 Decompresses the input buffer using the specified decompression method. More...
 

Detailed Description

This file contains declarations of compression utilities.

Enumeration Type Documentation

Compression algorithms.

Enumerator
GZIP_COMPRESSION_TYPE 

gzip compression

DEFLATE_COMPRESSION_TYPE 

Deflate compression.

Function Documentation

void UTILITIES_DECLSPEC CompressBuffer ( COMPRESSION_TYPE  mCompressionType,
const char *  mInputBuffer,
size_t  mInputBufferSize,
char *  mCompressedBuffer,
size_t  mCompressedBufferSize,
size_t *  mCompressedBodyUsedBytes 
)

Compresses the input buffer using the specified compression method.

mCompressedBuffer must be large enough to hold all compressed data.
For deflate compression, the destination buffer size (mCompressedBufferSize) must be at least 0.1% larger than mInputBufferSize + 12 bytes.
For gzip, add 20 bytes to the mCompressedBufferSize for the gzip header.

Parameters
mCompressionTypeCompression type (gzip or deflate)
mInputBufferInput buffer contains uncompressed data
mInputBufferSizeThe number of bytes to compress
mCompressedBufferOutput buffer for compressed data
mCompressedBufferSizeCapacity of mCompressedBuffer
mCompressedBodyUsedBytesCount of compressed bytes written to output buffer
bool UTILITIES_DECLSPEC DecompressBuffer ( COMPRESSION_TYPE  mCompressionType,
const char *  mInputBuffer,
size_t  mInputBufferSize,
char *  mDecompressedBuffer,
size_t  mDecompressedBufferSize,
size_t *  mDecompressedBodyUsedBytes,
size_t *  mInputBufferUsedBytes 
)

Decompresses the input buffer using the specified decompression method.

DecompressBuffer can be called repeatedly to process a large buffer in stages.
On each invocation, the function decompresses as much data as possible. It stops when the input buffer is empty or the output buffer is full.

Returns
True if the input buffer is completely decompressed into the output buffer.
Parameters
mCompressionTypeCompression type (gzip or deflate)
mInputBufferInput buffer contains compressed data
mInputBufferSizeThe number of bytes to decompress
mDecompressedBufferOutput buffer for uncompressed data
mDecompressedBufferSizeCapacity of mDecompressedBuffer
mDecompressedBodyUsedBytesCount of decompressed bytes written to output buffer
mInputBufferUsedBytesCount of bytes from the input buffer that were decompressed


Send documentation feedback to HP.


© 1995-2015 Hewlett-Packard Development Company, L.P.