uk.co.real_logic.artio.fixp

Interface FixPConnectionHandler

All Known Subinterfaces:

ILink3ConnectionHandler

public interface FixPConnectionHandler

This handler should be implemented by anyone using Artio to connect to binary FIXP protocols - such as CME's . Your application code will receive callbacks on these messages in response to business level messages. Artio handles session level messages itself. NB: This is an experimental API and is subject to change or potentially removal.

Method Summary

Modifier and Type	Method and Description
io.aeron.logbuffer.ControlledFragmentHandler.Action	onBusinessMessage(FixPConnection connection, int templateId, org.agrona.DirectBuffer buffer, int offset, int blockLength, int version, boolean possRetrans, FixPMessageHeader messageHeader) Callback for receiving business messages.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onDisconnect(FixPConnection connection, DisconnectReason reason) Callback invoked when this connection is disconnected.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onError(FixPConnection connection, java.lang.Exception ex) Callback when an error happens internally with the processing of a message in iLink3 that can't be handled through normal protocol means.
default io.aeron.logbuffer.ControlledFragmentHandler.Action	onFinishedSending(FixPConnection connection) Callback invoked when this connection receives a FinishedSending message from a counter-party.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onNotApplied(FixPConnection connection, long fromSequenceNumber, long msgCount, NotAppliedResponse response) Callback when Artio has received a NotApplied message.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onRetransmitReject(FixPConnection connection, java.lang.String reason, long requestTimestamp, int errorCodes) Callback when Artio has received a RetransmitReject message.
default io.aeron.logbuffer.ControlledFragmentHandler.Action	onRetransmitRequest(FixPConnection connection, RetransmissionInfo retransmissionInfo) Callback when Artio has received a RetransmitRequest message.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onRetransmitTimeout(FixPConnection connection) Callback triggered by a timeout on a retransmit request.
io.aeron.logbuffer.ControlledFragmentHandler.Action	onSequence(FixPConnection connection, long nextSeqNo) Notifies an application when a sequence message is received.

Method Detail

onBusinessMessage

io.aeron.logbuffer.ControlledFragmentHandler.Action onBusinessMessage(FixPConnection connection,
                                                                      int templateId,
                                                                      org.agrona.DirectBuffer buffer,
                                                                      int offset,
                                                                      int blockLength,
                                                                      int version,
                                                                      boolean possRetrans,
                                                                      FixPMessageHeader messageHeader)

Callback for receiving business messages. Note that the offset provided here is for the SBE message itself and doesn't include the header, but a user of this API can always assume that the header of the message exists before the message itself. So for example if you want to take the offset and length of the SBE message, including its MessageHeader and Simple Open Framing Header then you could do the following calculation on the offset and length parameters. final int encodedLength = b3.entrypoint.fixp.sbe.MessageHeaderDecoder.ENCODED_LENGTH + uk.co.real_logic.artio.fixp.SimpleOpenFramingHeader.SOFH_LENGTH; offset -= encodedLength; length += encodedLength;

Parameters:

connection - the connection receiving this message

templateId - the templateId of the SBE message that you have received.

buffer - the buffer containing the message.

offset - the offset within the buffer at which your message starts.

blockLength - the blockLength of the received message.

version - the sbe version of the protocol.

possRetrans - true of the possRetrans flag is set to true.

messageHeader - additional fields related to the message.

Returns:

an action to indicate the correct back pressure behaviour.

onNotApplied

io.aeron.logbuffer.ControlledFragmentHandler.Action onNotApplied(FixPConnection connection,
                                                                 long fromSequenceNumber,
                                                                 long msgCount,
                                                                 NotAppliedResponse response)

Callback when Artio has received a NotApplied message. The NotAppliedResponse parameter can be used in order to get Artio to retransmit messages or use a Sequence message in order to fill the gap.

Parameters:

connection - the connection receiving this message

fromSequenceNumber - the fromSequenceNumber of the NotApplied message.

msgCount - the msgCount of the NotApplied message.

response - used to tell Artio how to respond to the NotApplied message.

Returns:

an action to indicate the correct back pressure behaviour.

onRetransmitReject

io.aeron.logbuffer.ControlledFragmentHandler.Action onRetransmitReject(FixPConnection connection,
                                                                       java.lang.String reason,
                                                                       long requestTimestamp,
                                                                       int errorCodes)

Callback when Artio has received a RetransmitReject message. This can be used for error logging or handling.

Parameters:

connection - the connection receiving this message

reason - the reason of the RetransmitReject message

requestTimestamp - the requestTimestamp of the RetransmitReject message

errorCodes - the errorCodes of the RetransmitReject message

Returns:

an action to indicate the correct back pressure behaviour.

onRetransmitRequest

default io.aeron.logbuffer.ControlledFragmentHandler.Action onRetransmitRequest(FixPConnection connection,
                                                                                RetransmissionInfo retransmissionInfo)

Callback when Artio has received a RetransmitRequest message. This can be used to reject retransmission attempts or to log errored requests.

Parameters:

connection - the connection receiving this message.

retransmissionInfo - provides information about the retransmission message and how to reject them.

Returns:

an action to indicate the correct back pressure behaviour.

onRetransmitTimeout

io.aeron.logbuffer.ControlledFragmentHandler.Action onRetransmitTimeout(FixPConnection connection)

Callback triggered by a timeout on a retransmit request. See ILink3ConnectionConfiguration.Builder.retransmitNotificationTimeoutInMs(int) for details.

Parameters:

connection - the connection that initiated the retransmit request.

Returns:

an action to indicate the correct back pressure behaviour.

onSequence

io.aeron.logbuffer.ControlledFragmentHandler.Action onSequence(FixPConnection connection,
                                                               long nextSeqNo)

Notifies an application when a sequence message is received. Normally applications would not need to implement this method or take any behaviour in response to a sequence message - Artio itself provides any session level protocol responses. This method just exposes the event to applications for debugging or certification purposes.

Parameters:

connection - the connection receiving this message

nextSeqNo - the next sequence number contained in the body of the sequence message.

Returns:

an action to indicate the correct back pressure behaviour.

onError

io.aeron.logbuffer.ControlledFragmentHandler.Action onError(FixPConnection connection,
                                                            java.lang.Exception ex)

Callback when an error happens internally with the processing of a message in iLink3 that can't be handled through normal protocol means.

Parameters:

connection - the connection where this error has occurred.

ex - the exception corresponding to an error

Returns:

an action to indicate the correct back pressure behaviour.

onDisconnect

io.aeron.logbuffer.ControlledFragmentHandler.Action onDisconnect(FixPConnection connection,
                                                                 DisconnectReason reason)

Callback invoked when this connection is disconnected.

Parameters:

connection - the connection that was disconnected.

reason - the reason for the disconnection.

Returns:

an action to indicate the correct back pressure behaviour.

onFinishedSending

default io.aeron.logbuffer.ControlledFragmentHandler.Action onFinishedSending(FixPConnection connection)

Callback invoked when this connection receives a FinishedSending message from a counter-party. No more business messages will be received from the counter-party after this point. If your application has no more messages to send then it should invoke connection.finishedSending() unless it has already called finishedSending() to start the process. Your application may continue to send messages until it has invoked that method. NB: implementing this method is strictly optional. Not all FIXP protocols (eg: iLink3) implement the finished sending / finished receiving mechanism for protocol finalization and this method won't be invoked in the case of those protocols.

Parameters:

connection - the connection that has received the FinishedSending message

Returns:

an action to indicate the correct back pressure behaviour.