uk.co.real_logic.artio.fixp

Interface FixPConnection

All Known Subinterfaces:

ILink3Connection

public interface FixPConnection

Represents a Connection of a Binary protocol based upon FIXP - for example iLink3 or Binary Entrypoint This is a FIXP session protocol with SBE encoded binary messages. Unlike FIX it possible to have multiple connections open with the same session id. NB: This is an experimental API and is subject to change or potentially removal.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FixPConnection.State Defines the internal state of the Session, this can be accessed using the state() method.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NOT_AWAITING_RETRANSMIT

Method Summary

Modifier and Type	Method and Description
void	abort() Abort a message that has been claimed.
boolean	canSendMessage() Check if a message can be sent.
void	commit() Commit a message that has been claimed.
long	connectionId() Gets the Artio connectionId of the current connection for this session.
long	counterpartyKeepAliveIntervalInMs()
boolean	isConnected() Returns true if a connection is connected at this point in time.
FixPKey	key() Gets the key associated with this connection.
long	nextRecvSeqNo() Gets the next sequence number to be expected when receiving a new business layer message.
void	nextRecvSeqNo(long nextRecvSeqNo) Sets the next sequence number to be expected when receiving a new business layer message.
long	nextSentSeqNo() Gets the next sequence number to be used when sending a new business layer message.
void	nextSentSeqNo(long nextSentSeqNo) Sets the next sequence number to be used when sending a new business layer message.
long	ourKeepAliveIntervalInMs()
long	requestDisconnect(DisconnectReason reason) Disconnect your session, providing a reason.
FixPConnection.State	state() Gets the current State of this session.
long	tryClaim(org.agrona.sbe.MessageEncoderFlyweight message) Tries to send a business layer message with no variable length or group fields.
long	tryClaim(org.agrona.sbe.MessageEncoderFlyweight message, int variableLength) Tries to send a business layer message with a variable length or group fields.
long	trySendSequence() Try to send a sequence message indicating the current sent sequence number position.

Field Detail

NOT_AWAITING_RETRANSMIT

static final long NOT_AWAITING_RETRANSMIT

See Also:

Constant Field Values

Method Detail

tryClaim

long tryClaim(org.agrona.sbe.MessageEncoderFlyweight message)

Tries to send a business layer message with no variable length or group fields. This method claims a buffer slot for the flyweight object to wrap. If this method returns successfully then the flyweight's fields can be used. After the flyweight is filled in then the commit() method should be used to commit the message.

Parameters:

message - the business layer message to send.

Returns:

the position in the stream that corresponds to the end of this message or a negative number indicating an error status.

See Also:

tryClaim(MessageEncoderFlyweight, int)

tryClaim

long tryClaim(org.agrona.sbe.MessageEncoderFlyweight message,
              int variableLength)

Tries to send a business layer message with a variable length or group fields. This method claims a buffer slot for the flyweight object to wrap. If this method returns successfully then the flyweight's fields can be used. After the flyweight is filled in then the commit() method should be used to commit the message.

Parameters:

message - the business layer message to send.

variableLength - the total size of all the variable length and group fields in the message including their headers. Aka the total length of the message minus it's block length.

Returns:

the position in the stream that corresponds to the end of this message or a negative number indicating an error status.

See Also:

tryClaim(MessageEncoderFlyweight)

commit

void commit()

Commit a message that has been claimed. Do not overlap sending other messages or polling the FixLibrary with claiming and committing your own message - just claim and commit it immediately. If an error happens during the initialization of the message then you should call abort()

See Also:

tryClaim(MessageEncoderFlyweight), tryClaim(MessageEncoderFlyweight, int), abort()

abort

void abort()

Abort a message that has been claimed. If an error happens when initialising a message flyweight after a call to tryClaim() then this method can be called in order to abort the message and not send it.

See Also:

tryClaim(MessageEncoderFlyweight), tryClaim(MessageEncoderFlyweight, int), abort()

trySendSequence

long trySendSequence()

Try to send a sequence message indicating the current sent sequence number position. This can be combined with nextSentSeqNo(long) in order to move the sent sequence number forward in agreement with the exchange.

Returns:

the position in the stream that corresponds to the end of this message or a negative number indicating an error status.

requestDisconnect

long requestDisconnect(DisconnectReason reason)

Disconnect your session, providing a reason. This is an immediate TCP disconnect with no Terminate message sent.

Parameters:

reason - the reason you disconnected.

Returns:

the position in the stream that corresponds to the end of this message or a negative number indicating an error status.

connectionId

long connectionId()

Gets the Artio connectionId of the current connection for this session.

Returns:

the Artio connectionId of the current connection for this session.

state

FixPConnection.State state()

Gets the current State of this session.

Returns:

the current State of this session.

nextSentSeqNo

long nextSentSeqNo()

Gets the next sequence number to be used when sending a new business layer message.

Returns:

the next sequence number to be used when sending a new business layer message.

nextSentSeqNo

void nextSentSeqNo(long nextSentSeqNo)

Sets the next sequence number to be used when sending a new business layer message.

Parameters:

nextSentSeqNo - the next sequence number to be used when sending a new business layer message.

nextRecvSeqNo

long nextRecvSeqNo()

Gets the next sequence number to be expected when receiving a new business layer message.

Returns:

the next sequence number to be expected when receiving a new business layer message.

nextRecvSeqNo

void nextRecvSeqNo(long nextRecvSeqNo)

Sets the next sequence number to be expected when receiving a new business layer message.

Parameters:

nextRecvSeqNo - the next sequence number to be expected when receiving a new business layer message.

canSendMessage

boolean canSendMessage()

Check if a message can be sent. This is when you're in the ESTABLISHED or AWAITING_KEEPALIVE state.

Returns:

true if a message can be sent, false otherwise

key

FixPKey key()

Gets the key associated with this connection. This uniquely identifies it over multiple establishments

Returns:

the key associated with this connection.

isConnected

boolean isConnected()

Returns true if a connection is connected at this point in time.

Returns:

true if a connection is connected at this point in time.

counterpartyKeepAliveIntervalInMs

long counterpartyKeepAliveIntervalInMs()

ourKeepAliveIntervalInMs

long ourKeepAliveIntervalInMs()