com.apama.iaf.plugin
Interface EventTransport

All Known Implementing Classes:

AbstractEventTransport

public interface EventTransport

EventTransport defines the interface that Java IAF transports implement so they can be used by the IAF to send an upstream event that has passed through the Semantic Mapper and encoder.

Field Summary

static int

API_VERSION Transport API version.

Method Summary

void	sendTransportEvent(java.lang.Object event, TimestampSet timestamps) Called by an event encoder to send an upstream message to the external transport.

Field Detail

API_VERSION

static final int API_VERSION

Transport API version. The upper 16 bits identify the major release of the API; the lower 16 bits indicate minor versions within that release. No changes that break backward binary compatibility will be made within a given major release of the API. That is, minor releases may add functionality and fix bugs, but will not change or remove any documented behaviour. Version history: 1.1 First public version, with interface similar to C interface 1.1. 4.0 Addition of high-accuracy timestamps for latency measurement.

See Also:

Constant Field Values

Method Detail

sendTransportEvent

void sendTransportEvent(java.lang.Object event,
                        TimestampSet timestamps)
                        throws TransportException

Called by an event encoder to send an upstream message to the external transport.

It is assumed that the encoder and transport share the same definition of the content of the event, so that the transport can effectively interpret the event.

Parameters:

event - An object representing the event to be sent by the transport, in a format shared by the encoder and transport.

timestamps - A TimestampSet representing the timestamps attached to the event.

Throws:

TransportException - Thrown by the transport if any error occurs sending the message.