FIX::FileStore Class Reference

File based implementation of MessageStore. More...

#include <FileStore.h>

Inheritance diagram for FIX::FileStore:

Collaboration diagram for FIX::FileStore:

Public Member Functions
	FileStore (std::string, const SessionID &s)
virtual	~FileStore ()
bool	set (int, const std::string &) throw ( IOException )
void	get (int, int, std::vector< std::string > &) const throw ( IOException )
int	getNextSenderMsgSeqNum () const throw ( IOException )
int	getNextTargetMsgSeqNum () const throw ( IOException )
void	setNextSenderMsgSeqNum (int value) throw ( IOException )
void	setNextTargetMsgSeqNum (int value) throw ( IOException )
void	incrNextSenderMsgSeqNum () throw ( IOException )
void	incrNextTargetMsgSeqNum () throw ( IOException )
UtcTimeStamp	getCreationTime () const throw ( IOException )
void	reset () throw ( IOException )
void	refresh () throw ( IOException )
Public Member Functions inherited from FIX::MessageStore
virtual	~MessageStore ()

Private Types
typedef std::pair< long, std::size_t >	OffsetSize
typedef std::map< int, OffsetSize >	NumToOffset

Private Member Functions
void	open (bool deleteFile)
void	populateCache ()
bool	readFromFile (int offset, int size, std::string &msg)
void	setSeqNum ()
void	setSession ()
bool	get (int, std::string &) const throw ( IOException )

Private Attributes
MemoryStore	m_cache
NumToOffset	m_offsets
std::string	m_msgFileName
std::string	m_headerFileName
std::string	m_seqNumsFileName
std::string	m_sessionFileName
FILE *	m_msgFile
FILE *	m_headerFile
FILE *	m_seqNumsFile
FILE *	m_sessionFile

Detailed Description

File based implementation of MessageStore.

Four files are created by this implementation. One for storing outgoing messages, one for indexing message locations, one for storing sequence numbers, and one for storing the session creation time.

The formats of the files are:
   [path]+[BeginString]-[SenderCompID]-[TargetCompID].body
   [path]+[BeginString]-[SenderCompID]-[TargetCompID].header
   [path]+[BeginString]-[SenderCompID]-[TargetCompID].seqnums
   [path]+[BeginString]-[SenderCompID]-[TargetCompID].session

The messages file is a pure stream of FIX messages.

The sequence number file is in the format of
   [SenderMsgSeqNum] : [TargetMsgSeqNum]

The session file is a UTC timestamp in the format of
   YYYYMMDD-HH:MM:SS

Definition at line 81 of file FileStore.h.

Member Typedef Documentation

NumToOffset

typedef std::map< int, OffsetSize > FIX::FileStore::NumToOffset

private

Definition at line 108 of file FileStore.h.

OffsetSize

typedef std::pair< long, std::size_t > FIX::FileStore::OffsetSize

private

Definition at line 106 of file FileStore.h.

Constructor & Destructor Documentation

FileStore()

FIX::FileStore::FileStore	(	std::string	path,
		const SessionID &	s )

Definition at line 34 of file FileStore.cpp.

: m_msgFile( 0 ), m_headerFile( 0 ), m_seqNumsFile( 0 ), m_sessionFile( 0 )
{
  file_mkdir( path.c_str() );
 
  if ( path.empty() ) path = ".";
  const std::string& begin =
    s.getBeginString().getString();
  const std::string& sender =
    s.getSenderCompID().getString();
  const std::string& target =
    s.getTargetCompID().getString();
  const std::string& qualifier =
    s.getSessionQualifier();
 
  std::string sessionid = begin + "-" + sender + "-" + target;
  if( qualifier.size() )
    sessionid += "-" + qualifier;
 
  std::string prefix
    = file_appendpath(path, sessionid + ".");
 
  m_msgFileName = prefix + "body";
  m_headerFileName = prefix + "header";
  m_seqNumsFileName = prefix + "seqnums";
  m_sessionFileName = prefix + "session";
 
  try
  {
    open( false );
  }
  catch ( IOException & e )
  {
    throw ConfigError( e.what() );
  }
}

References FIX::file_appendpath(), FIX::file_mkdir(), FIX::SessionID::getBeginString(), FIX::SessionID::getSenderCompID(), FIX::SessionID::getSessionQualifier(), FIX::SessionID::getTargetCompID(), m_headerFile, m_headerFileName, m_msgFile, m_msgFileName, m_seqNumsFile, m_seqNumsFileName, m_sessionFile, m_sessionFileName, and open().

~FileStore()

FIX::FileStore::~FileStore ( )

virtual

Definition at line 71 of file FileStore.cpp.

{
  if( m_msgFile ) fclose( m_msgFile );
  if( m_headerFile ) fclose( m_headerFile );
  if( m_seqNumsFile ) fclose( m_seqNumsFile );
  if( m_sessionFile ) fclose( m_sessionFile );
}

References m_headerFile, m_msgFile, m_seqNumsFile, and m_sessionFile.

Member Function Documentation

get() [1/2]

void FIX::FileStore::get ( int begin, int end, std::vector< std::string > & result ) const throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 223 of file FileStore.cpp.

{
  result.clear();
  std::string msg;
  for ( int i = begin; i <= end; ++i )
  {
    if ( get( i, msg ) )
      result.push_back( msg );
  }
}

References get().

Referenced by get().

get() [2/2]

bool FIX::FileStore::get ( int msgSeqNum, std::string & msg ) const throw ( IOException )

private

Definition at line 324 of file FileStore.cpp.

{
  NumToOffset::const_iterator find = m_offsets.find( msgSeqNum );
  if ( find == m_offsets.end() ) return false;
  const OffsetSize& offset = find->second;
  if ( fseek( m_msgFile, offset.first, SEEK_SET ) ) 
    throw IOException( "Unable to seek in file " + m_msgFileName );
  char* buffer = new char[ offset.second + 1 ];
  size_t result = fread( buffer, sizeof( char ), offset.second, m_msgFile );
  if ( ferror( m_msgFile ) || result != (size_t)offset.second ) 
  {
    delete [] buffer;
    throw IOException( "Unable to read from file " + m_msgFileName );
  }
  buffer[ offset.second ] = 0;
  msg = buffer;
  delete [] buffer;
  return true;
}

References m_msgFile, m_msgFileName, and m_offsets.

getCreationTime()

UtcTimeStamp FIX::FileStore::getCreationTime ( ) const throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 270 of file FileStore.cpp.

{
  return m_cache.getCreationTime();
}

References m_cache.

getNextSenderMsgSeqNum()

int FIX::FileStore::getNextSenderMsgSeqNum ( ) const throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 236 of file FileStore.cpp.

{
  return m_cache.getNextSenderMsgSeqNum();
}

References m_cache.

Referenced by open(), and setSeqNum().

getNextTargetMsgSeqNum()

int FIX::FileStore::getNextTargetMsgSeqNum ( ) const throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 241 of file FileStore.cpp.

{
  return m_cache.getNextTargetMsgSeqNum();
}

References m_cache.

Referenced by open(), and setSeqNum().

incrNextSenderMsgSeqNum()

void FIX::FileStore::incrNextSenderMsgSeqNum ( ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 258 of file FileStore.cpp.

{
  m_cache.incrNextSenderMsgSeqNum();
  setSeqNum();
}

References m_cache, and setSeqNum().

incrNextTargetMsgSeqNum()

void FIX::FileStore::incrNextTargetMsgSeqNum ( ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 264 of file FileStore.cpp.

{
  m_cache.incrNextTargetMsgSeqNum();
  setSeqNum();
}

References m_cache, and setSeqNum().

open()

void FIX::FileStore::open ( bool deleteFile )

private

Definition at line 79 of file FileStore.cpp.

{
  if ( m_msgFile ) fclose( m_msgFile );
  if ( m_headerFile ) fclose( m_headerFile );
  if ( m_seqNumsFile ) fclose( m_seqNumsFile );
  if ( m_sessionFile ) fclose( m_sessionFile );
 
  m_msgFile = 0;
  m_headerFile = 0;
  m_seqNumsFile = 0;
  m_sessionFile = 0;
 
  if ( deleteFile )
  {
    file_unlink( m_msgFileName.c_str() );
    file_unlink( m_headerFileName.c_str() );
    file_unlink( m_seqNumsFileName.c_str() );
    file_unlink( m_sessionFileName.c_str() );
  }
 
  populateCache();
  m_msgFile = file_fopen( m_msgFileName.c_str(), "r+" );
  if ( !m_msgFile ) m_msgFile = file_fopen( m_msgFileName.c_str(), "w+" );
  if ( !m_msgFile ) throw ConfigError( "Could not open body file: " + m_msgFileName );
 
  m_headerFile = file_fopen( m_headerFileName.c_str(), "r+" );
  if ( !m_headerFile ) m_headerFile = file_fopen( m_headerFileName.c_str(), "w+" );
  if ( !m_headerFile ) throw ConfigError( "Could not open header file: " + m_headerFileName );
 
  m_seqNumsFile = file_fopen( m_seqNumsFileName.c_str(), "r+" );
  if ( !m_seqNumsFile ) m_seqNumsFile = file_fopen( m_seqNumsFileName.c_str(), "w+" );
  if ( !m_seqNumsFile ) throw ConfigError( "Could not open seqnums file: " + m_seqNumsFileName );
 
  bool setCreationTime = false;
  m_sessionFile = file_fopen( m_sessionFileName.c_str(), "r" );
  if ( !m_sessionFile ) setCreationTime = true;
  else fclose( m_sessionFile );
 
  m_sessionFile = file_fopen( m_sessionFileName.c_str(), "r+" );
  if ( !m_sessionFile ) m_sessionFile = file_fopen( m_sessionFileName.c_str(), "w+" );
  if ( !m_sessionFile ) throw ConfigError( "Could not open session file" );
  if ( setCreationTime ) setSession();
 
  setNextSenderMsgSeqNum( getNextSenderMsgSeqNum() );
  setNextTargetMsgSeqNum( getNextTargetMsgSeqNum() );
}

References FIX::file_fopen(), FIX::file_unlink(), getNextSenderMsgSeqNum(), getNextTargetMsgSeqNum(), m_headerFile, m_headerFileName, m_msgFile, m_msgFileName, m_seqNumsFile, m_seqNumsFileName, m_sessionFile, m_sessionFileName, populateCache(), setNextSenderMsgSeqNum(), setNextTargetMsgSeqNum(), and setSession().

Referenced by FileStore(), refresh(), and reset().

populateCache()

void FIX::FileStore::populateCache ( )

private

Definition at line 126 of file FileStore.cpp.

{
  FILE* headerFile = file_fopen( m_headerFileName.c_str(), "r+" );
  if ( headerFile )
  {
    int num;
    long offset;
    std::size_t size;
 
    while (FILE_FSCANF(headerFile, "%d,%ld,%lu ", &num, &offset, &size) == 3)
    {
      std::pair<NumToOffset::iterator, bool> it = 
        m_offsets.insert(NumToOffset::value_type(num, std::make_pair(offset, size)));
      //std::cout << it.first->second.first << " --- " << it.first->second.second << '\n';
      if (it.second == false)
      {
        it.first->second = std::make_pair(offset, size);
      }
    }
    fclose( headerFile );
  }
 
  FILE* seqNumsFile = file_fopen( m_seqNumsFileName.c_str(), "r+" );
  if ( seqNumsFile )
  {
    int sender, target;
    if ( FILE_FSCANF( seqNumsFile, "%d : %d", &sender, &target ) == 2 )
    {
      m_cache.setNextSenderMsgSeqNum( sender );
      m_cache.setNextTargetMsgSeqNum( target );
    }
    fclose( seqNumsFile );
  }
 
  FILE* sessionFile = file_fopen( m_sessionFileName.c_str(), "r+" );
  if ( sessionFile )
  {
    char time[ 22 ];
#ifdef HAVE_FSCANF_S
    int result = FILE_FSCANF( sessionFile, "%s", time, 22 );
#else
    int result = FILE_FSCANF( sessionFile, "%s", time );
#endif
    if( result == 1 )
    {
      m_cache.setCreationTime( UtcTimeStampConvertor::convert( time ) );
    }
    fclose( sessionFile );
  }
}

References FIX::UtcTimeStampConvertor::convert(), FIX::file_fopen(), FILE_FSCANF, m_cache, m_headerFileName, m_offsets, m_seqNumsFileName, and m_sessionFileName.

Referenced by open().

readFromFile()

bool FIX::FileStore::readFromFile ( int offset, int size, std::string & msg )

private

refresh()

void FIX::FileStore::refresh ( ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 289 of file FileStore.cpp.

{
  try
  {
    m_cache.reset();
    open( false );
  }
  catch( std::exception& e )
  {
    throw IOException( e.what() );
  }
}

References m_cache, and open().

reset()

void FIX::FileStore::reset ( ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 275 of file FileStore.cpp.

{
  try
  {
    m_cache.reset();
    open( true );
    setSession();
  }
  catch( std::exception& e )
  {
    throw IOException( e.what() );
  }
}

References m_cache, open(), and setSession().

set()

bool FIX::FileStore::set ( int msgSeqNum, const std::string & msg ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 192 of file FileStore.cpp.

{
  if ( fseek( m_msgFile, 0, SEEK_END ) ) 
    throw IOException( "Cannot seek to end of " + m_msgFileName );
  if ( fseek( m_headerFile, 0, SEEK_END ) ) 
    throw IOException( "Cannot seek to end of " + m_headerFileName );
 
  long offset = ftell( m_msgFile );
  if ( offset < 0 ) 
    throw IOException( "Unable to get file pointer position from " + m_msgFileName );
  std::size_t size = msg.size();
 
  if ( fprintf( m_headerFile, "%d,%ld,%lu ", msgSeqNum, offset, size ) < 0 )
    throw IOException( "Unable to write to file " + m_headerFileName );
  std::pair<NumToOffset::iterator, bool> it = 
    m_offsets.insert(NumToOffset::value_type(msgSeqNum, std::make_pair(offset, size)));
  if (it.second == false)
  {
    it.first->second = std::make_pair(offset, size);
  }
  fwrite( msg.c_str(), sizeof( char ), msg.size(), m_msgFile );
  if ( ferror( m_msgFile ) ) 
    throw IOException( "Unable to write to file " + m_msgFileName );
  if ( fflush( m_msgFile ) == EOF ) 
    throw IOException( "Unable to flush file " + m_msgFileName );
  if ( fflush( m_headerFile ) == EOF ) 
    throw IOException( "Unable to flush file " + m_headerFileName );
  return true;
}

References m_headerFile, m_headerFileName, m_msgFile, m_msgFileName, and m_offsets.

setNextSenderMsgSeqNum()

void FIX::FileStore::setNextSenderMsgSeqNum ( int value ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 246 of file FileStore.cpp.

{
  m_cache.setNextSenderMsgSeqNum( value );
  setSeqNum();
}

References m_cache, and setSeqNum().

Referenced by open().

setNextTargetMsgSeqNum()

void FIX::FileStore::setNextTargetMsgSeqNum ( int value ) throw ( IOException )

virtual

Implements FIX::MessageStore.

Definition at line 252 of file FileStore.cpp.

{
  m_cache.setNextTargetMsgSeqNum( value );
  setSeqNum();
}

References m_cache, and setSeqNum().

Referenced by open().

setSeqNum()

void FIX::FileStore::setSeqNum ( )

private

Definition at line 302 of file FileStore.cpp.

{
  rewind( m_seqNumsFile );
  fprintf( m_seqNumsFile, "%10.10d : %10.10d",
           getNextSenderMsgSeqNum(), getNextTargetMsgSeqNum() );
  if ( ferror( m_seqNumsFile ) ) 
    throw IOException( "Unable to write to file " + m_seqNumsFileName );
  if ( fflush( m_seqNumsFile ) ) 
    throw IOException( "Unable to flush file " + m_seqNumsFileName );
}

References getNextSenderMsgSeqNum(), getNextTargetMsgSeqNum(), m_seqNumsFile, and m_seqNumsFileName.

Referenced by incrNextSenderMsgSeqNum(), incrNextTargetMsgSeqNum(), setNextSenderMsgSeqNum(), and setNextTargetMsgSeqNum().

setSession()

void FIX::FileStore::setSession ( )

private

Definition at line 313 of file FileStore.cpp.

{
  rewind( m_sessionFile );
  fprintf( m_sessionFile, "%s",
           UtcTimeStampConvertor::convert( m_cache.getCreationTime() ).c_str() );
  if ( ferror( m_sessionFile ) ) 
    throw IOException( "Unable to write to file " + m_sessionFileName );
  if ( fflush( m_sessionFile ) ) 
    throw IOException( "Unable to flush file " + m_sessionFileName );
}

References FIX::UtcTimeStampConvertor::convert(), m_cache, m_sessionFile, and m_sessionFileName.

Referenced by open(), and reset().

Member Data Documentation

m_cache

MemoryStore FIX::FileStore::m_cache

private

Definition at line 118 of file FileStore.h.

Referenced by getCreationTime(), getNextSenderMsgSeqNum(), getNextTargetMsgSeqNum(), incrNextSenderMsgSeqNum(), incrNextTargetMsgSeqNum(), populateCache(), refresh(), reset(), setNextSenderMsgSeqNum(), setNextTargetMsgSeqNum(), and setSession().

m_headerFile

FILE* FIX::FileStore::m_headerFile

private

Definition at line 127 of file FileStore.h.

Referenced by FileStore(), open(), set(), and ~FileStore().

m_headerFileName

std::string FIX::FileStore::m_headerFileName

private

Definition at line 122 of file FileStore.h.

Referenced by FileStore(), open(), populateCache(), and set().

m_msgFile

FILE* FIX::FileStore::m_msgFile

private

Definition at line 126 of file FileStore.h.

Referenced by FileStore(), get(), open(), set(), and ~FileStore().

m_msgFileName

std::string FIX::FileStore::m_msgFileName

private

Definition at line 121 of file FileStore.h.

Referenced by FileStore(), get(), open(), and set().

m_offsets

NumToOffset FIX::FileStore::m_offsets

private

Definition at line 119 of file FileStore.h.

Referenced by get(), populateCache(), and set().

m_seqNumsFile

FILE* FIX::FileStore::m_seqNumsFile

private

Definition at line 128 of file FileStore.h.

Referenced by FileStore(), open(), setSeqNum(), and ~FileStore().

m_seqNumsFileName

std::string FIX::FileStore::m_seqNumsFileName

private

Definition at line 123 of file FileStore.h.

Referenced by FileStore(), open(), populateCache(), and setSeqNum().

m_sessionFile

FILE* FIX::FileStore::m_sessionFile

private

Definition at line 129 of file FileStore.h.

Referenced by FileStore(), open(), setSession(), and ~FileStore().

m_sessionFileName

std::string FIX::FileStore::m_sessionFileName

private

Definition at line 124 of file FileStore.h.

Referenced by FileStore(), open(), populateCache(), and setSession().

---

The documentation for this class was generated from the following files:

• FileStore.h
• FileStore.cpp