FileLine

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

com.apama.file
Event FileLine

FileLine events are sent to or returned from the adapter. Each line is associated with a specific sessionId, and the data is stored within a sequence of strings.

Member summary
`string`	`transportName` The name of the transport being used within the file adapter.
`integer`	`requestId` An ID value for associated events in each direction.
`integer`	`sessionId` The session Id this FileLine event is for or from.
`sequence<string>`	`data` The data as a sequence of strings.

Member detail

data

sequence<string> data

The data as a sequence of strings.

requestId

integer requestId

An ID value for associated events in each direction.

In the upstream direction (i.e. writing):

1) If this value is negative, the adapter will send no acknowledgement.

There is no guarantee that this line will actually get written to disk until either a non-negative requestId is sent, or the file is closed.

A FileError may be sent back in response if this request generates an error. If the user is always using the same requestId e.g. -1, then they will not be able to work out which line generated the error.

The application writer is free to ignore listening for these errors should they wish.

2) If this value is 0 or greater, then the adapter will send an acknowledgement LineWritten event back to the application.

Each such write will cause the line to be flushed to disk by the time the acknowledgement is received. If you are doing large numbers of writes, it may be better for performance to use a negative requestId until you have completed your batch.

In the downstream direction this field will contain the same value as provided in the corresponding ReadLines event.

sessionId

integer sessionId

The session Id this FileLine event is for or from.

transportName

string transportName

The name of the transport being used within the file adapter.