com.thomsonreuters.ema.access.GenericMsg 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;

import java.nio.ByteBuffer;

/**
 * GenericMsg allows applications to bidirectionally send messages without any implied
 * message semantics.

 * GenericMsg may be sent on any item stream using {@link OmmConsumer#submit(GenericMsg, long)}.


 * 
 * Objects of this class are intended to be short lived or rather transitional.

 * This class is designed to efficiently perform setting and getting of information from GenericMsg.

 * Objects of this class are not cache-able.

 * Decoding of just encoded GenericMsg in the same application is not supported.
 */
public interface GenericMsg extends Msg
{
	/**
	 * Indicates presence of SeqNum.

	 * Sequence number is an optional member of GenericMsg.
	 * 
	 * @return true if sequence number is set; false otherwise
	 */
	public boolean hasSeqNum();
	
	/** 
	 * Indicates presence of SecondarySeqNum.

	 * Secondary sequence number is an optional member of GenericMsg.
	 * 
	 * @return true if secondary sequence number is set; false otherwise
	 */
	public boolean hasSecondarySeqNum();
	
	/**
	 * Indicates presence of PartNum.

	 * Part number is an optional member of GenericMsg.
	 * 
	 * @return true if part number is set; false otherwise
	 */
	public boolean hasPartNum();
	
	/**
	 * Indicates presence of PermissionData.

	 * Permission data is optional on GenericMsg.
	 * 
	 * @return true if permission data is set; false otherwise
	 */
	public boolean hasPermissionData();
	
	/**
	 * Returns SeqNum.

	 * Calling this method must be preceded by a call to {@link #hasSeqNum()}.
	 * 
	 * @throws OmmInvalidUsageException if {@link #hasSeqNum()} returns false
	 * 
	 * @return sequence number
	 */
	public long seqNum();
	
	/**
	 * Returns SecondarySeqNum.

	 * Calling this method must be preceded by a call to {@link #hasSecondarySeqNum()}.
	 * 
	 * @throws OmmInvalidUsageException if {@link #hasSecondarySeqNum()} returns false
	 * 
	 * @return secondary sequence number
	 */
	public long secondarySeqNum();
	
	/** 
	 * Returns PartNum.
	 * 
Calling this method must be preceded by a call to {@link #hasPartNum()}.
	 * 
	 * @throws OmmInvalidUsageException if {@link #hasPartNum()} returns false
	 * 
	 * @return part number
	 */
	public int partNum();
	
	/**
	 * Returns PermissionData.

	 * Calling this method must be preceded by a call to {@link #hasPermissionData()}.
	 * 
	 * @throws OmmInvalidUsageException if {@link #hasPermissionData()} returns false
	 * 
	 * @return ByteBuffer containing permission data
	*/
	public ByteBuffer permissionData();
	
	/**
	 * Returns Complete.
	 * 
	 * @return true if this is a one part generic message or the final part of the multi part generic message.
	 */
	public boolean complete();

	/**
	 * Clears the GenericMsg.

	 * Invoking clear() method clears all the values and resets all the defaults.
	 * 
	 * @return reference to this object
	 */
	public GenericMsg clear();
	
	/**
	 * Specifies StreamId.
	 * 
	 * @throws OmmOutOfRangeException if streamId is {@literal < -2147483648 or > 2147483647}
	 * 
	 * @param streamId specifies stream id
	 * @return reference to this object
	 */
	public GenericMsg streamId(int streamId);
	
	/**
	 * Specifies DomainType.
	 * 
	 * @throws OmmUnsupportedDomainTypeException if domainType is is {@literal < 0 or > 255}
	 * 
	 * @param domainType specifies RDM Message Model Type
	 * 
	 * @return reference to this object
	 */
	public GenericMsg domainType(int domainType);
	
	/**
	 * Specifies Name.
	 * 
	 * @throws OmmInvalidUsageException if name is null
	 * 
	 * @param name specifies item name
	 * @return reference to this object
	 */
	public GenericMsg name(String name);
	
	/**
	 * Specifies NameType.
	 * 
	 * @throws OmmOutOfRangeException if nameType is {@literal < 0 or > 255}
	 * 
	 * @param nameType specifies RDM Instrument NameType
	 *        
	 * @return reference to this object
	 */
	public GenericMsg nameType(int nameType);
	
	/**
	 * Specifies ServiceId.
	 * 
	 * @throws OmmOutOfRangeException if serviceId is {@literal < 0 or > 65535}
	 * 
	 * @param serviceId specifies service id
	 * @return reference to this object
	 */
	public GenericMsg serviceId(int serviceId);
	
	/**
	 * Specifies Id.
	 *
	 * @throws OmmOutOfRangeException if id is {@literal < -2147483648 or > 2147483647}
	 * 
	 * @param id specifies Id
	 * @return reference to this object
	 */
	public GenericMsg id(int id);
	
	/**
	 * Specifies Filter.
	 * 
	 * @throws OmmOutOfRangeException if filter is {@literal < 0 or > 4294967295L}
	 * 
	 * @param filter specifies filter
	 * @return reference to this object
	 */
	public GenericMsg filter(long filter);
	
	/**
	 * Specifies SeqNum.
	 *
	 * @throws OmmOutOfRangeException if filter is {@literal < 0 or > 4294967295L}
	 * 
	 * @param seqNum specifies sequence number
	 * @return reference to this object
	 */
	public GenericMsg seqNum(long seqNum);
	
	/**
	 * Specifies SecondarySeqNum.
	 * 
	 * @throws OmmOutOfRangeException if secondarySeqNum is {@literal < 0 or > 4294967295L}
	 * 
	 * @param secondarySeqNum specifies secondary sequence number
	 * @return reference to this object
	 */
	public GenericMsg secondarySeqNum(long secondarySeqNum);
	
	/**
	 * Specifies PartNum.
	 * 
	 * @throws OmmOutOfRangeException if partNum is {@literal < 0 or > 4294967295L}
	 * 
	 * @param partNum specifies part number
	 * @return reference to this object
	 */
	public GenericMsg partNum(int partNum);
	
	/**
	 * Specifies PermissionData.
	 * 
	 * @throws OmmInvalidUsageException if permissionData is null
	 * 
	 * @param permissionData a ByteBuffer object with permission data information
	 * @return reference to this object
	 */
	public GenericMsg permissionData(ByteBuffer permissionData);
	
	/**
	 * Specifies Attrib.
	 * 
	 * @throws OmmInvalidUsageException if data is null
	 * 
	 * @param data an object of ComplexType
	 * @return reference to this object
	 */
	public GenericMsg attrib(ComplexType data);
	
	/**
	 * Specifies Payload.
	 *
	 * @throws OmmInvalidUsageException if data is null
	 * 
	 * @param data an object of ComplexType
	 * @return reference to this object
	 */
	public GenericMsg payload(ComplexType data);
	
	/**
	 * Specifies ExtendedHeader.
	 * 
	 * @throws OmmInvalidUsageException if buffer is null
	 * 
	 * @param buffer ByteBuffer containing extendedHeader information
	 * @return reference to this object
	 */
	public GenericMsg extendedHeader(ByteBuffer buffer);
	
	/**
	 * Specifies Complete.

	 * Must be set to true for one part generic message.
	 * 
	 * @param complete specifies if this is the last part of the multi part generic message
	 * @return reference to this object
	 */
	public GenericMsg complete(boolean complete);
}