LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
rcsc::GZCompressor Class Reference

compress message string More...

#include <gzcompressor.h>

Public Member Functions

 GZCompressor (const int level=6)
 construct with compression level More...
 
 ~GZCompressor ()
 destruct implementation
 
int setLevel (const int level)
 set zlib compression level More...
 
int compress (const char *src_buf, const int src_size, std::string &dest)
 compress the src_buf and copy output buffer to std::string More...
 

Detailed Description

compress message string

Constructor & Destructor Documentation

◆ GZCompressor()

rcsc::GZCompressor::GZCompressor ( const int  level = 6)
explicit

construct with compression level

Parameters
levelzlib compression level. [1,9]

Member Function Documentation

◆ compress()

int rcsc::GZCompressor::compress ( const char *  src_buf,
const int  src_size,
std::string &  dest 
)

compress the src_buf and copy output buffer to std::string

Parameters
src_bufpointer to the source buffer
src_sizesize of source buffer
destdestination string variable
Returns
status of compression

◆ setLevel()

int rcsc::GZCompressor::setLevel ( const int  level)

set zlib compression level

Parameters
levelzlib compression level. [1,9]
Returns
result status of deflateParams

The documentation for this class was generated from the following file: