quickfix

Interface MessageStore

All Known Implementing Classes:

CachedFileStore, FileStore, MemoryStore, NoopStore, SleepycatStore

public interface MessageStore

Used by a Session to store and retrieve messages for resend purposes.

See Also:

Session

Method Summary

Modifier and Type	Method and Description
void	get(int startSequence, int endSequence, Collection<String> messages) Get messages within sequence number range (inclusive).
Date	getCreationTime() Get the session creation time.
int	getNextSenderMsgSeqNum()
int	getNextTargetMsgSeqNum()
void	incrNextSenderMsgSeqNum()
void	incrNextTargetMsgSeqNum()
void	refresh() Refresh session state from a shared state storage (e.g. database, file, ...).
void	reset() Reset the message store.
boolean	set(int sequence, String message) Adds a raw fix messages to the store with the given sequence number.
void	setNextSenderMsgSeqNum(int next)
void	setNextTargetMsgSeqNum(int next)

Method Detail

set

boolean set(int sequence,
            String message)
     throws IOException

Adds a raw fix messages to the store with the given sequence number. (Most implementations just append the message data to the store so be careful about assuming random access behavior.)

Parameters:

sequence - the sequence number

message - the raw FIX message string

Returns:

true is successful, false otherwise

Throws:

IOException - IO error

get

void get(int startSequence,
         int endSequence,
         Collection<String> messages)
  throws IOException

Get messages within sequence number range (inclusive). Used for message resend requests.

Parameters:

startSequence - the starting message sequence number.

endSequence - the ending message sequence number.

messages - the retrieved messages (out parameter)

Throws:

IOException - IO error

getNextSenderMsgSeqNum

int getNextSenderMsgSeqNum()
                    throws IOException

Throws:

IOException

getNextTargetMsgSeqNum

int getNextTargetMsgSeqNum()
                    throws IOException

Throws:

IOException

setNextSenderMsgSeqNum

void setNextSenderMsgSeqNum(int next)
                     throws IOException

Throws:

IOException

setNextTargetMsgSeqNum

void setNextTargetMsgSeqNum(int next)
                     throws IOException

Throws:

IOException

incrNextSenderMsgSeqNum

void incrNextSenderMsgSeqNum()
                      throws IOException

Throws:

IOException

incrNextTargetMsgSeqNum

void incrNextTargetMsgSeqNum()
                      throws IOException

Throws:

IOException

getCreationTime

Date getCreationTime()
              throws IOException

Get the session creation time.

Returns:

the session creation time.

Throws:

IOException - IO error

reset

void reset()
    throws IOException

Reset the message store. Sequence numbers are set back to 1 and stored messages are erased. The session creation time is also set to the time of the reset.

Throws:

IOException - IO error

refresh

void refresh()
      throws IOException

Refresh session state from a shared state storage (e.g. database, file, ...). Refresh will not work for message stores without shared state (e.g., MemoryStore). These stores should log an session error, at a minimum, or throw an exception.

Throws:

IOException