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

Go to download

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

Enterprise 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;

/**
 * ServiceEndpointDiscoveryEvent encapsulates query identifiers.
 * 
 * ServiceEndpointDiscoveryEvent is used to convey query identifiers to application.

 * ServiceEndpointDiscoveryEvent is returned through ServiceEndpointDiscoveryClient callback methods.
 * 
 * ServiceEndpointDiscoveryEvent is read only. It is used for query identification only.
 * 
 * @see ServiceEndpointDiscovery
 * @see ServiceEndpointDiscoveryClient
 */
public interface ServiceEndpointDiscoveryEvent
{
	/**
	 * Returns an identifier (a.k.a., closure) associated with a query by consumer application.

	 * Application associates the closure with a query on 
	 * {@link com.thomsonreuters.ema.access.ServiceEndpointDiscovery#registerClient(ServiceEndpointDiscoveryOption, ServiceEndpointDiscoveryClient, Object)} method
	 * 
	 * @return closure value
	 */
	public Object closure();
	
	/**
	 * Returns ServiceEndpointDiscovery instance for this event.
	 * 
	 * @return reference to ServiceEndpointDiscovery
	 */
	public ServiceEndpointDiscovery serviceEndpointDiscovery();
}