Home

Traffic Server Software Developers Kit

Prev — INKIOBufferStart
INKIOBufferWaterMarkSet — Next

INKIOBufferWaterMarkGet

Gets the current watermark for the specified buffer.

Prototype

InkReturnCode INKIOBufferWaterMarkGet (INKIOBuffer bufp, int *watermark)

Arguments

INKIOBuffer bufp is the IOBuffer whose water_mark is to be obtained.

int *watermark is set to the watermark value.

Description

Gets the current watermark for the specified buffer. A water mark applies only to a NetVConnection and should therefore only be used when reading data from one.

When the watermark is set to N and after INKVConnRead is called, the net processor calls back the reader (with an event INK_VCONN_READ_READY) only when at least N bytes of data are available for reading.

Returns

INK_SUCCESS if the API call is successful.

INK_ERROR if an error occurs while calling the API or if an argument is invalid.