Chain

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.softwareag.connectivity
Event Chain

Represents a chain instance and provides methods to perform various operations on it.

Action summary
`void`	`ackUpTo(string messageId)` Acknowledge that a specific event and all previous events received from this connectivity chain have been reliably processed by your application.
`void`	`destroy()` Destroy this chain instance. Chains that are managed by a dynamic chain manager cannot be destroyed this way. This should be called only once.
`integer`	`flush()` Ask the chain to acknowledge all events previously sent to it by the application. A FlushAck reply will be sent to the current context once these events have been reliably processed by the external system.
`string`	`getId()` Return the unique id of the chain instance.

Action detail

ackUpTo

void ackUpTo(string messageId)

Acknowledge that a specific event and all previous events received from this connectivity chain have been reliably processed by your application.

If you are going to make use of this action, then the message id of the incoming events will need to be available somehow. For example, as a field on the event.

This action will only have an effect on chains with a reliable-messaging-aware transport, and should not be used otherwise.

Parameters:: messageId - The message id of the specific event

See Also:: com.softwareag.connectivity.control.AckRequired - In some situations it may make more sense to do acknowledgments on AckRequired requests, rather than against events of the application's choice.

destroy

void destroy()

Destroy this chain instance. Chains that are managed by a dynamic chain manager cannot be destroyed this way. This should be called only once.

flush

integer flush()

Ask the chain to acknowledge all events previously sent to it by the application. A FlushAck reply will be sent to the current context once these events have been reliably processed by the external system.

This action will only have an effect on chains with a reliable-messaging-aware transport, and should not be used otherwise.

A transport will still handle events that are sent to it, whether or not flushing is used. A flush request is purely a signalling mechanism.