com.refinitiv.ema.access.OmmQos 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.8.2.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.refinitiv.ema.access;

/**
 * OmmQos represents Quality Of Service information in Omm.
 * 
 * OmmQos is a read only class.

 * This class is used for extraction of OmmQos only.
 *
 * @see Data
 */
public interface OmmQos extends Data
{
	/**
	 * Rate represents Qos rate.
	 */
	public static class  Rate
	{
		/**
		 * Indicates tick by tick rate
		 */
		public final static int TICK_BY_TICK = 0;

		/**
		 * Indicates just in time conflated rate
		 */
		public final static int JUST_IN_TIME_CONFLATED = 0xFFFFFF00;
	}

	/**
	 * Timeliness represents Qos timeliness.
	*/
	public static class  Timeliness
	{
		/**
		 * Indicates real time timeliness
		 */
		public final static int REALTIME = 0;

		/**
		 * Indicates timeliness with an unknown delay value
		 */
		public final static int INEXACT_DELAYED = 0xFFFFFFFF;
	}

	/**
	 * Returns the QosRate value as a string format.
	 * 
	 * @return string representation of this object Rate
	*/
	public String rateAsString();
		
	/**
	 * Returns the QosTimeliness value as a string format.
	 * 
	 * @return string representation of this object timeliness
	*/
	public String timelinessAsString();

	/**
	 * Returns Timeliness.
	 * 
	 * @return value of OmmQos Timeliness
	 */
	public int timeliness();

	/** Returns Rate.
	 * 
	 * @return value of OmmQos Rate
	*/
	public int rate();
}