com.vertica.sdk.State.StreamState Enum Reference

Collaboration diagram for com.vertica.sdk.State.StreamState:

Public Member Functions
int	getCode ()

Public Attributes
	DONE =(2)
	INPUT_NEEDED =(0)
	KEEP_GOING =(4)
	OUTPUT_NEEDED =(1)
	REJECT =(3)

Detailed Description

StreamState indicates the state of a stream after process() has handled some input and some output data. See the UDSource, UDFilter, and UDParser classes for how these streams are used.

Member Data Documentation

DONE

com.vertica.sdk.State.StreamState.DONE =(2)

The stream has completed; it will not be writing any more output nor consuming any more input.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

INPUT_NEEDED

com.vertica.sdk.State.StreamState.INPUT_NEEDED =(0)

Indicates that a stream is unable to continue without being given more input. It may not have consumed all of its available input yet. It does not need to have consumed every byte of input. Not valid for output-only streams, ie., UDSources.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

KEEP_GOING

com.vertica.sdk.State.StreamState.KEEP_GOING =(4)

Not commonly used; the stream has neither filled all of its output buffer nor consumed all of its input buffer, but would like to yield to the server. Typically it has neither consumed data nor produced data. This state should be used instead of a "wait" loop; a stream that is waiting for some external operation to complete should periodically return KEEP_GOING rather than simply blocking forever.

Referenced by com.vertica.sdk.ContinuousUDParser.process().

OUTPUT_NEEDED

com.vertica.sdk.State.StreamState.OUTPUT_NEEDED =(1)

Indicates that a stream is unable to write more output without being given a new or larger output buffer. Basically that it has "filled" the buffer as much as it is reasonably able to (which may be every byte full, some bytes full, even completely empty – in which case Vertica assumes that the UDL needs a larger buffer). Not valid for input-only streams, ie., UDParsers.

REJECT

com.vertica.sdk.State.StreamState.REJECT =(3)

Only valid for UDParsers, indicates that the Parser has encountered an invalid entry that it cannot process. Parsers may reject exactly one row at a time.

See also

UDParser::getRejectedRecord()

Referenced by com.vertica.sdk.ContinuousUDParser.process().