stream

FRAMES NO FRAMES

Overview

Package

Deprecated

Help

API Reference for EPL (ApamaDoc) 10.5.4.1

SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION

DETAIL: IMPORT | CONSTANT | MEMBER | ACTION

<Default Package>
Type stream < ELEMENT >

Type Parameters:: ELEMENT - The element type of the stream. This can be any event type, location, boolean, decimal, float, integer, or string.

A stream of typed events.

A value of stream type refers to a stream. Each stream is a conduit or channel through which items flow. The item types that can flow through streams are event, location, boolean, decimal, float, integer, or string. A stream transports items of only one type. Streams are internal to a monitor.

An event can contain a field of type stream, however you cannot send, emit, route, or enqueue an event that has a stream type field. Also, you cannot specify an event that has a stream field in an event template.

The syntax for declaring a stream variable is:

stream<ELEMENT> varname;

Stream variables should be assigned using the from statement and can be used as arguments to further from statements.

An empty stream cannot be used in any meaningful way. To use the variable, you must assign a non-empty stream to it. Attempting to use an empty stream in a from statement will throw an exception.

Streams are not routable, parseable or comparable.

Action summary
`stream<ELEMENT>`	`clone()` Return a reference to this stream.
`void`	`quit()` Terminate the stream.

Action detail

clone

stream<ELEMENT> clone()

Return a reference to this stream.

This does not create a copy.

Returns:: This stream.

quit

void quit()

Terminate the stream.

Causes the stream and all queries that it feeds to terminate and cease receiving events. This method is idempotent and silently does nothing if the stream has already been quit, self-terminated or is uninitialized.