NLNET::CMessageRecorder Class Reference

#include <message_recorder.h>

---

Detailed Description

Message recorder. The service performs sends normally. They are intercepted and the recorder plays the receives back. No communication with other hosts. Warning: it works only with messages as plain text.

Author:

Olivier Cado

Nevrax France

Date:

2001

Definition at line 116 of file message_recorder.h.

Public Member Functions
TNetworkEvent	checkNextOne (sint64 updatecounter)
	CMessageRecorder ()
	Constructor.
void	recordNext (sint64 updatecounter, TNetworkEvent event, TSockId sockid, CMessage &message)
	Add a record.
TNetworkEvent	replayConnectionAttempt (const CInetAddress &addr)
	Get the first stored connection attempt corresponding to addr.
void	replayNextDataAvailable (sint64 updatecounter)
	Push the received blocks for this counter into the receive queue.
bool	startRecord (const std::string &filename, bool recordall=true)
	Start recording.
bool	startReplay (const std::string &filename)
	Start replaying.
void	stopRecord ()
	Stop recording.
void	stopReplay ()
	Stop playback.
	~CMessageRecorder ()
	Destructor.
Data Fields
std::queue< NLNET::TMessageRecord >	ReceivedMessages
	Receive queue (corresponding to one update count). Use empty(), front(), pop().
Protected Member Functions
bool	getNext (TMessageRecord &record, sint64 updatecounter)
	Get the next record (from the preloaded records, or from the file).
bool	loadNext (TMessageRecord &record)
	Load the next record from the file (throws EStreamOverflow).
Private Attributes
std::deque< TMessageRecord >	_ConnectionAttempts
std::fstream	_File
std::string	_Filename
std::deque< TMessageRecord >	_PreloadedRecords
bool	_RecordAll

---

Constructor & Destructor Documentation

NLNET::CMessageRecorder::CMessageRecorder (   )

Constructor. Definition at line 79 of file message_recorder.cpp. References nlerror. : _RecordAll(true) { #ifndef MESSAGES_PLAIN_TEXT nlerror( "The message recorder works only with plain text messages. Please #define MESSAGES_PLAIN_TEXT" ); #endif }

NLNET::CMessageRecorder::~CMessageRecorder (   )

Destructor. Definition at line 90 of file message_recorder.cpp. References nldebug, stopRecord(), and stopReplay(). { if ( _Filename != "" ) { nldebug( "MR:%s: End of recording", _Filename.c_str() ); } stopRecord(); stopReplay(); }

---

Member Function Documentation

TNetworkEvent NLNET::CMessageRecorder::checkNextOne (  sint64  updatecounter  )

Returns the event type if the counter of the next event is updatecounter, and skip it; otherwise return Error. Definition at line 308 of file message_recorder.cpp. References NLNET::Error, NLNET::TMessageRecord::Event, NLNET::EventToString(), getNext(), NL_I64, nldebug, sint64, and NLNET::TNetworkEvent. { TMessageRecord record; if ( getNext( record, updatecounter ) ) { nldebug( "MR: Check next one: %s at update %"NL_I64"u", EventToString(record.Event).c_str(), updatecounter ); return record.Event; } else { return Error; } }

bool NLNET::CMessageRecorder::getNext (  TMessageRecord &  record, sint64  updatecounter )  [protected]

Get the next record (from the preloaded records, or from the file). Definition at line 230 of file message_recorder.cpp. References _PreloadedRecords, loadNext(), nlassert, and sint64. Referenced by checkNextOne(), and replayNextDataAvailable(). { if ( ! _PreloadedRecords.empty() ) { if ( _PreloadedRecords.front().UpdateCounter == updatecounter ) { // The requested record is in the preload record = _PreloadedRecords.front(); _PreloadedRecords.pop_front(); return true; } else { // The requested record is not in the file nlassert( updatecounter < _PreloadedRecords.front().UpdateCounter ); // not > return false; } } else { if ( loadNext( record ) ) { if ( record.UpdateCounter == updatecounter ) { // The requested record has been loaded return true; } else { // The next loaded record is a new one nlassert( updatecounter < record.UpdateCounter ); // not > _PreloadedRecords.push_back( record ); // when we read one too far return false; } } else { return false; } } }

bool NLNET::CMessageRecorder::loadNext (  TMessageRecord &  record  )  [protected]

Load the next record from the file (throws EStreamOverflow). Definition at line 198 of file message_recorder.cpp. References _File, len, nlassert, nldebug, nlstop, NLNET::TMessageRecord::serial(), and uint32. Referenced by getNext(), and replayConnectionAttempt(). { // WARNING!!! This features doesn't work anymore becaues bufferAsVector() is not available with new CMemStream nlstop; return false; nlassert( _File.is_open() ); // Dump from file CMemStream stream ( true, true ); uint32 len; char c; _File >> c; // skip "* "; _File >> (int&)len; _File.ignore(); // skip delimiter if ( ! _File.fail() ) { _File.get( (char*)stream.bufferToFill( len+1 ), len+1, '\0' ); //stream.bufferAsVector().resize( len ); // cut end of cstring nldebug( "MR:%s: Reading [%s]", _Filename.c_str(), stream.buffer() ); // Serial from stream record.serial( stream ); // may throw EStreamOverflow if _File.fail() } return ! _File.fail(); // retest }

void NLNET::CMessageRecorder::recordNext (  sint64  updatecounter, TNetworkEvent  event, TSockId  sockid, CMessage &  message )

Add a record. Todo: cado: Does a silent Access Violation Definition at line 141 of file message_recorder.cpp. References _File, _RecordAll, len, nlassert, nldebug, NLNET::Sending, NLNET::TMessageRecord::serial(), sint64, and NLNET::TSockId. { nlassert( _File.is_open() ); if ( (_RecordAll) || (event != Sending) ) { // Serial to stream TMessageRecord rec ( event, sockid, message, updatecounter /*CTime::getLocalTime()*/ ); CMemStream stream ( false, true ); rec.serial( stream ); char c = '\0'; // end of cstring stream.serial( c ); // added to the stream for _File << (char*)stream.buffer() // Dump to file nldebug( "MR:%s: Recording [%s]", _Filename.c_str(), stream.buffer() ); int len = (int)(stream.length()-2); // not the null character (and its separator) at the end of the buffer _File << "* "; _File << len; // if we put the expression directly, it makes an access violation ! Weird. _File << " "; _File << (char*)stream.buffer() << endl; } }

TNetworkEvent NLNET::CMessageRecorder::replayConnectionAttempt (  const CInetAddress &  addr  )

Get the first stored connection attempt corresponding to addr. Definition at line 326 of file message_recorder.cpp. References _ConnectionAttempts, _PreloadedRecords, addr, NLNET::Connecting, NLNET::ConnFailing, NLNET::Error, NLNET::TMessageRecord::Event, loadNext(), NLNET::TMessageRecord::Message, NL_I64, nldebug, nlstop, NLMISC::CMemStream::serial(), NLNET::TNetworkEvent, and NLNET::TMessageRecord::UpdateCounter. { TNetworkEvent event; deque<TMessageRecord>::iterator ipr; if ( ! _ConnectionAttempts.empty() ) { // Search in the already processed connection attempts for ( ipr=_ConnectionAttempts.begin(); ipr!=_ConnectionAttempts.end(); ++ipr ) { CInetAddress stored_addr; (*ipr).Message.serial( stored_addr ); if ( stored_addr == addr ) { // Found event = (*ipr).Event; nldebug( "MR: Connection attempt found at update %"NL_I64"u", (*ipr).UpdateCounter ); _ConnectionAttempts.erase( ipr ); return event; } } } // Seek in the preloaded records for ( ipr=_PreloadedRecords.begin(); ipr!=_PreloadedRecords.end(); ++ipr ) { event = (*ipr).Event; if ( (event == Connecting) || (event == ConnFailing) ) { CInetAddress stored_addr; (*ipr).Message.serial( stored_addr ); if ( stored_addr == addr ) { // Found nldebug( "MR: Connection attempt found at update %"NL_I64"u", (*ipr).UpdateCounter ); _PreloadedRecords.erase( ipr ); return event; } } } if ( ipr==_PreloadedRecords.end() ) { // If not found, load next records until found ! TMessageRecord rec( true ); while ( loadNext( rec ) ) { if ( ( rec.Event == Connecting ) || ( rec.Event == ConnFailing ) ) { CInetAddress stored_addr; rec.Message.serial( stored_addr ); if ( stored_addr == addr ) { // Found nldebug( "MR: Connection attempt found at update %"NL_I64"u", rec.UpdateCounter ); return rec.Event; } else { _PreloadedRecords.push_back( rec ); } } else { _PreloadedRecords.push_back( rec ); } } // Not found nldebug( "MR: Connection attempt not found" ); return Error; } nlstop; return Error; }

void NLNET::CMessageRecorder::replayNextDataAvailable (  sint64  updatecounter  )

Push the received blocks for this counter into the receive queue. Definition at line 276 of file message_recorder.cpp. References _ConnectionAttempts, NLNET::Accepting, NLNET::Connecting, NLNET::ConnFailing, NLNET::Disconnecting, NLNET::TMessageRecord::Event, getNext(), nlstop, ReceivedMessages, NLNET::Receiving, NLNET::Sending, and sint64. { TMessageRecord rec( true ); // input message while ( getNext( rec, updatecounter ) ) { switch ( rec.Event ) { case Receiving : case Accepting : case Disconnecting : ReceivedMessages.push( rec ); break; case Sending : break; case Connecting : case ConnFailing : _ConnectionAttempts.push_back( rec ); break; default : nlstop; } } }

bool NLNET::CMessageRecorder::startRecord (  const std::string &  filename, bool  recordall = true )

Start recording. Definition at line 104 of file message_recorder.cpp. References _File, _RecordAll, nldebug, and nlwarning. { _Filename = filename; _File.open( _Filename.c_str(), ios_base::out ); _File << endl; _RecordAll = recordall; if ( _File.fail() ) { nlwarning( "MR: Record: Cannot open file %s", _Filename.c_str() ); return false; } else { nldebug( "MR: Start recording into %s", _Filename.c_str() ); return true; } }

bool NLNET::CMessageRecorder::startReplay (  const std::string &  filename  )

Start replaying. Definition at line 178 of file message_recorder.cpp. References _File, nldebug, and nlerror. { _Filename = filename; _File.open( _Filename.c_str(), ios_base::in ); if ( _File.fail() ) { nlerror( "MR: Replay: Cannot open file %s", _Filename.c_str() ); return false; } else { nldebug( "MR: Start replaying from %s", _Filename.c_str() ); return true; } }

void NLNET::CMessageRecorder::stopRecord (   )

Stop recording. Definition at line 168 of file message_recorder.cpp. References _File. Referenced by ~CMessageRecorder(). { _File.close(); _Filename = ""; }

void NLNET::CMessageRecorder::stopReplay (   )

Stop playback. Definition at line 404 of file message_recorder.cpp. References _File. Referenced by ~CMessageRecorder(). { _File.close(); _Filename = ""; }

---

Field Documentation

std::deque<TMessageRecord> NLNET::CMessageRecorder::_ConnectionAttempts [private]

Definition at line 176 of file message_recorder.h. Referenced by replayConnectionAttempt(), and replayNextDataAvailable().

std::fstream NLNET::CMessageRecorder::_File [private]

Definition at line 167 of file message_recorder.h. Referenced by loadNext(), recordNext(), startRecord(), startReplay(), stopRecord(), and stopReplay().

std::string NLNET::CMessageRecorder::_Filename [private]

Definition at line 170 of file message_recorder.h.

std::deque<TMessageRecord> NLNET::CMessageRecorder::_PreloadedRecords [private]

Definition at line 173 of file message_recorder.h. Referenced by getNext(), and replayConnectionAttempt().

bool NLNET::CMessageRecorder::_RecordAll [private]

Definition at line 179 of file message_recorder.h. Referenced by recordNext(), and startRecord().

std::queue<NLNET::TMessageRecord> NLNET::CMessageRecorder::ReceivedMessages

Receive queue (corresponding to one update count). Use empty(), front(), pop(). Definition at line 154 of file message_recorder.h. Referenced by replayNextDataAvailable().

---

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

• message_recorder.h
• message_recorder.cpp

---