AllowHTTPCompression Property

Enables HTTP compression for receiving data.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetAllowHTTPCompression();
int SetAllowHTTPCompression(int bAllowHTTPCompression);

Unicode (Windows)
BOOL GetAllowHTTPCompression();
INT SetAllowHTTPCompression(BOOL bAllowHTTPCompression);

@property (nonatomic,readwrite,assign,getter=allowHTTPCompression,setter=setAllowHTTPCompression:) BOOL allowHTTPCompression;
- (BOOL)allowHTTPCompression;
- (void)setAllowHTTPCompression:(BOOL)newAllowHTTPCompression;

#define PID_HTTP_ALLOWHTTPCOMPRESSION 2

IPWORKS_EXTERNAL void* IPWORKS_CALL IPWorks_HTTP_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKS_EXTERNAL int IPWORKS_CALL IPWorks_HTTP_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

TRUE

Remarks

This property enables HTTP compression for receiving data. When set to true, the class will accept compressed data. It will then uncompress the data it has received. The class will handle data compressed by both GZIP and Deflate compression algorithms.

When true, the class adds an "Accept-Encoding" header to the outgoing request. The value for this header can be controlled by the AcceptEncoding config. The default value for this header is "gzip, deflate".

TransferredData will contain the decompressed data received by the server, but the Transfer event will report exactly what is received by the server (compressed data).

Data Type

Boolean