.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "Z_DECOMPRESS" "9" "09 October 2005" "" ""

.SH NAME
z_decompress \- decompress a Deflate-compressed packet.
.SH SYNOPSIS
"SYNOPSIS"
.sp
\fB
.sp
int z_decompress  (void * \fIarg\fB, unsigned char * \fIibuf\fB, int \fIisize\fB, unsigned char * \fIobuf\fB, int \fIosize\fB);
\fR
.SH "ARGUMENTS"
.TP
\fB\fIarg\fB\fR
pointer to private state for the decompressor
.TP
\fB\fIibuf\fB\fR
pointer to input (compressed) packet data
.TP
\fB\fIisize\fB\fR
length of input packet
.TP
\fB\fIobuf\fB\fR
pointer to space for output (decompressed) packet
.TP
\fB\fIosize\fB\fR
amount of space available at \fIobuf\fR
.SH "DESCRIPTION"
.PP
Because of patent problems, we return DECOMP_ERROR for errors
found by inspecting the input data and for system problems, but
DECOMP_FATALERROR for any errors which could possibly be said to
be being detected ``after'' decompression.  For DECOMP_ERROR,
we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
infringing a patent of Motorola's if we do, so we take CCP down
instead.
.PP
Given that the frame has the correct sequence number and a good FCS,
errors such as invalid codes in the input most likely indicate a
bug, so we return DECOMP_FATALERROR for them in order to turn off
compression, even though they are detected by inspecting the input.