statcmpResult Structure Definition

The statcmpResult structure defines the return type for statcmp API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

cmpList

Pointer to the cmp List.


cmpstats Structure Definition

The cmpstats structure defines the actual return type values for statcmp API.

Syntax



Members

clearstats

Clear the statsistics / counters

_nextgenapiresource


delbwsaving

Bandwidth saving from delta compression expressed as percentage.

delcmpratio

Ratio of compressible data received to compressed data transmitted.If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet.

decomptcpratio

Ratio of decompressed data transmitted to compressed data received.

decomptcpbandwidthsaving

Bandwidth saving from TCP compression expressed as percentage.

comptcpratio

Ratio of compressible data received to compressed data transmitted.If this ratio is one (uncmp:1.0) that means compression is disabled or we are not able to compress even a single compressible packet.

comptcpbandwidthsaving

Bandwidth saving from TCP compression expressed as percentage.

comptotaldatacompressionratio

Ratio of total HTTP data received to total HTTP data transmitted.

comphttpbandwidthsaving

Bandwidth saving from TCP compression expressed as percentage.

compratio

Ratio of the compressible data received from the server to the compressed data sent to the client.

comptotalrequests

Number of HTTP compression requests the Citrix ADC receives for which the response is successfully compressed. For example, after you enable compression and configure services, if you send HTTP requests to the Citrix ADC using a HTTP client that supports compression, and Citrix ADC compresses the corresponding response, this counter is incremented.

comprequestsrate

Rate of HTTP compression requests the Citrix ADC receives for which the response is successfully compressed. For example, after you enable compression and configure services, if you send HTTP requests to the Citrix ADC using a HTTP client that supports compression, and Citrix ADC compresses the corresponding response, this counter is incremented.

comptotalrxbytes

Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

comprxbytesrate

Rate of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

comptotaltxbytes

Number of bytes the Citrix ADC sends to the client after compressing the response from the server.

comptxbytesrate

Rate of bytes the Citrix ADC sends to the client after compressing the response from the server.

comptotalrxpackets

Number of HTTP packets that can be compressed, which the Citrix ADC receives from the server.

comprxpacketsrate

Rate of HTTP packets that can be compressed, which the Citrix ADC receives from the server.

comptotaltxpackets

Number of HTTP packets that the Citrix ADC sends to the client after compressing the response from the server.

comptxpacketsrate

Rate of HTTP packets that the Citrix ADC sends to the client after compressing the response from the server.

comptcptotalrxbytes

Number of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

comptcprxbytesrate

Rate of bytes that can be compressed, which the Citrix ADC receives from the server. This gives the content length of the response that the Citrix ADC receives from server.

comptcptotalrxpackets

Total number of compressible packets received by Citrix ADC.

comptcprxpacketsrate

Rate of compressible packets received by Citrix ADC.

comptcptotaltxbytes

Number of bytes that the Citrix ADC sends to the client after compressing the response from the server.

comptcptxbytesrate

Rate of bytes that the Citrix ADC sends to the client after compressing the response from the server.

comptcptotaltxpackets

Number of TCP packets that the Citrix ADC sends to the client after compressing the response from the server.

comptcptxpacketsrate

Rate of TCP packets that the Citrix ADC sends to the client after compressing the response from the server.

comptcptotalquantum

Number of times the Citrix ADC compresses a quantum of data. Citrix ADC buffers the data received from the server till it reaches the quantum size and then compresses the buffered data and transmits to the client.

comptcpquantumrate

Rate of times the Citrix ADC compresses a quantum of data. Citrix ADC buffers the data received from the server till it reaches the quantum size and then compresses the buffered data and transmits to the client.

comptcptotalpush

Number of times the Citrix ADC compresses data on receiving a TCP PUSH flag from the server. The PUSH flag ensures that data is compressed immediately without waiting for the buffered data size to reach the quantum size.

comptcppushrate

Rate of times the Citrix ADC compresses data on receiving a TCP PUSH flag from the server. The PUSH flag ensures that data is compressed immediately without waiting for the buffered data size to reach the quantum size.

comptcptotaleoi

Number of times the Citrix ADC compresses data on receiving End Of Input (FIN packet). When the Citrix ADC receives End Of Input (FIN packet), it compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size.

comptcpeoirate

Rate of times the Citrix ADC compresses data on receiving End Of Input (FIN packet). When the Citrix ADC receives End Of Input (FIN packet), it compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size.

comptcptotaltimer

Number of times the Citrix ADC compresses data on expiration of data accumulation timer. The timer expires if the server response is very slow and consequently, the Citrix ADC does not receive response for a certain amount of time. Under such a condition, the Citrix ADC compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size.

comptcptimerrate

Rate of times the Citrix ADC compresses data on expiration of data accumulation timer. The timer expires if the server response is very slow and consequently, the Citrix ADC does not receive response for a certain amount of time. Under such a condition, the Citrix ADC compresses the buffered data immediately without waiting for the buffered data size to reach the quantum size.

decomptcprxbytes

Total number of compressed bytes received by Citrix ADC.

decomptcprxbytesrate

Rate of compressed bytes received by Citrix ADC.

decomptcprxpackets

Total number of compressed packets received by Citrix ADC.

decomptcprxpacketsrate

Rate of compressed packets received by Citrix ADC.

decomptcptxbytes

Total number of decompressed bytes transmitted by Citrix ADC.

decomptcptxbytesrate

Rate of decompressed bytes transmitted by Citrix ADC.

decomptcptxpackets

Total number of decompressed packets transmitted by Citrix ADC.

decomptcptxpacketsrate

Rate of decompressed packets transmitted by Citrix ADC.

decomptcperrdata

Number of data errors encountered while decompressing.

decomptcperrdatarate

Rate of data errors encountered while decompressing.

decomptcperrlessdata

Number of times Citrix ADC received less data than declared by protocol.

decomptcperrlessdatarate

Rate of times Citrix ADC received less data than declared by protocol.

decomptcperrmoredata

Number of times Citrix ADC received more data than declared by protocol.

decomptcperrmoredatarate

Rate of times Citrix ADC received more data than declared by protocol.

decomptcperrmemory

Number of times memory failures occurred while decompressing.

decomptcperrmemoryrate

Rate of times memory failures occurred while decompressing.

decomptcperrunknown

Number of times unknown errors occurred while decompressing.

decomptcperrunknownrate

Rate of times unknown errors occurred while decompressing.

delcomptotalrequests

Total number of delta compression requests received by Citrix ADC.

delcomprequestsrate

Rate of delta compression requests received by Citrix ADC.

delcompdone

Total number of delta compressions done by Citrix ADC.

delcompdonerate

Rate of delta compressions done by Citrix ADC.

delcomptcprxbytes

Total number of delta-compressible bytes received by Citrix ADC.

delcomptcprxbytesrate

Rate of delta-compressible bytes received by Citrix ADC.

delcomptcptxbytes

Total number of delta-compressed bytes transmitted by Citrix ADC.

delcomptcptxbytesrate

Rate of delta-compressed bytes transmitted by Citrix ADC.

delcompfirstaccess

Total number of delta compression first accesses.

delcompfirstaccessrate

Rate of delta compression first accesses.

delcomptcprxpackets

Number of delta-compressible packets received.

delcomptcprxpacketsrate

Rate of delta-compressible packets received.

delcomptcptxpackets

Total number of delta-compressed packets transmitted by Citrix ADC.

delcomptcptxpacketsrate

Rate of delta-compressed packets transmitted by Citrix ADC.

delcompbaseserved

Total number of basefile requests served by Citrix ADC.

delcompbaseservedrate

Rate of basefile requests served by Citrix ADC.

delcompbasetcptxbytes

Number of basefile bytes transmitted by Citrix ADC.

delcompbasetcptxbytesrate

Rate of basefile bytes transmitted by Citrix ADC.

delcomperrbypassed

Number of times delta-compression bypassed by Citrix ADC.

delcomperrbypassedrate

Rate of times delta-compression bypassed by Citrix ADC.

delcomperrbfilewhdrfailed

Number of times basefile could not be updated in Citrix ADC cache.

delcomperrbfilewhdrfailedrate

Rate of times basefile could not be updated in Citrix ADC cache.

delcomperrnostoremiss

Number of times basefile was not found in Citrix ADC cache.

delcomperrnostoremissrate

Rate of times basefile was not found in Citrix ADC cache.

delcomperrreqinfotoobig

Number of times basefile request URL was too large.

delcomperrreqinfotoobigrate

Rate of times basefile request URL was too large.

delcomperrreqinfoallocfail

Number of times requested basefile could not be allocated.

delcomperrreqinfoallocfailrate

Rate of times requested basefile could not be allocated.

delcomperrsessallocfail

Number of times delta compression session could not be allocated.

delcomperrsessallocfailrate

Rate of times delta compression session could not be allocated.

httptotrxresponsebytes

Total number of bytes of HTTP response data received.

httprxresponsebytesrate

Rate of bytes of HTTP response data received.

See Also