com.thomsonreuters.ema.access.OmmConsumerEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ema Show documentation

Elektron Message API (EMA) Java Edition

There is a newer version: 3.5.1.0

///*|-----------------------------------------------------------------------------
// *|            This source code is provided under the Apache 2.0 license      --
// *|  and is provided AS IS with no warranty or guarantee of fit for purpose.  --
// *|                See the project's LICENSE.md for details.                  --
// *|           Copyright (C) 2019 Refinitiv. All rights reserved.            --
///*|-----------------------------------------------------------------------------

package com.thomsonreuters.ema.access;

/**
 * OmmConsumerEvent encapsulates item identifiers.
 * 
 * OmmConsumerEvent is used to convey item identifiers to application.

 * OmmConsumerEvent is returned through OmmConsumerClient callback methods.
 * 
 * OmmConsumerEvent is read only. It is used for item identification only.
 * 
 * @see OmmConsumer
 * @see OmmConsumerClient
 */
public interface OmmConsumerEvent
{
	/**
	 * Returns a unique item identifier (a.k.a., item handle) associated by EMA with an open item stream.

	 * Item identifier is returned from all OmmConsumer registerClient() methods. For tunnel stream onStatusMsg()

	 * call backs this is the parent handle returned by the OmmConsumer registerClient() method. For tunnel stream

	 * sub-stream call backs this is the handle of the sub-stream itself. 
	 * 
	 * @return item identifier or handle
	 */
	public long handle();

	/**
	 * Returns an identifier (a.k.a., closure) associated with an open stream by consumer application.

	 * Application associates the closure with an open item stream on

	 * OmmConsumer registerClient(... , ... , Object closure, ...) methods
	 * 
	 * @return closure value
	 */
	public Object closure();

	/**
	 * Returns current item's parent item identifier (a.k.a. parent item handle).

	 * Application specifies parent item identifier on

	 * OmmConsumer registerClient(... , ... , ... , long parentHandle) method.

	 * For tunnel stream sub-stream call backs this is the handle of parent tunnel

	 * stream. For batch request items this is the item identifier of the top level

	 * batch request.
	 * 
	 * @return parent item identifier or parent handle
	*/
	public long parentHandle();

	/**
	 * Returns the channel information associated with the event.
	 * 
	 * @return the channel information associated with the event
	 */
	public ChannelInformation channelInformation();
}