uk.co.real_logic.artio.fixp

Class FixPRejectRefIdExtractor

java.lang.Object

uk.co.real_logic.artio.fixp.FixPRejectRefIdExtractor

public class FixPRejectRefIdExtractor
extends java.lang.Object

Generic way to lookup client order id fields that are used for business reject ref ids for FIXP protocols. It needs to take the Ir object in order to be initiated. This can be looked up using AbstractFixPOffsets.loadSbeIr(Class, String) or IrDecoder.decode(); Call the search method with a buffer in order to find the reject ref id for a given FIXP message. Single threaded.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLORDID
static java.lang.String	MESSAGE_TYPE
static int	MISSING_OFFSET

Constructor Summary

Constructors

Constructor and Description
FixPRejectRefIdExtractor(uk.co.real_logic.sbe.ir.Ir ir)

Method Summary

Modifier and Type	Method and Description
int	length() Get the length of the client order id within the buffer passed to search(DirectBuffer, int).
long	messageType() Get the message type of the message in question.
int	offset() Get the offset of the client order id within the buffer passed to search(DirectBuffer, int).
boolean	search(org.agrona.DirectBuffer buffer, int offset) Call to search a buffer for a given client order id if the message in question exists.
int	templateId() Get the template id of the message in question.
int	templateId(org.agrona.DirectBuffer buffer, int headerOffset)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MISSING_OFFSET

public static final int MISSING_OFFSET

See Also:

Constant Field Values

MESSAGE_TYPE

public static final java.lang.String MESSAGE_TYPE

See Also:

Constant Field Values

CLORDID

public static final java.lang.String CLORDID

See Also:

Constant Field Values

Constructor Detail

FixPRejectRefIdExtractor

public FixPRejectRefIdExtractor(uk.co.real_logic.sbe.ir.Ir ir)

Method Detail

search

public boolean search(org.agrona.DirectBuffer buffer,
                      int offset)

Call to search a buffer for a given client order id if the message in question exists. The accessor fields below are populated and can be used to retrieve the reject ref id, template id and message type of the message in question.

Parameters:

buffer - a buffer containing a message

offset - an offset into the buffer at the start of the SOFH.

Returns:

true if a reject ref id could be found, false otherwise.

templateId

public int templateId(org.agrona.DirectBuffer buffer,
                      int headerOffset)

templateId

public int templateId()

Get the template id of the message in question. If it doesn't exist then returns MISSING_OFFSET. You need to call search in order for this field to be populated.

Returns:

the template id of the message in question.

offset

public int offset()

Get the offset of the client order id within the buffer passed to search(DirectBuffer, int). If it doesn't exist then returns MISSING_OFFSET. You need to call search in order for this field to be populated.

Returns:

the offset of the client order id.

length

public int length()

Get the length of the client order id within the buffer passed to search(DirectBuffer, int). If it doesn't exist then returns MISSING_OFFSET. You need to call search in order for this field to be populated.

Returns:

the length of the client order id.

messageType

public long messageType()

Get the message type of the message in question. If it doesn't exist then returns MISSING_OFFSET. You need to call search in order for this field to be populated.

Returns:

the message type of the message in question.