flexiport::LogReaderPort Class Reference

Simulated port using a log file. More...

#include <flexiport/logreaderport.h>

Inheritance diagram for flexiport::LogReaderPort:

Collaboration diagram for flexiport::LogReaderPort:

Public Member Functions
	LogReaderPort (std::map< std::string, std::string > options)
	~LogReaderPort ()
void	Open ()
	Open the port.
void	Close ()
	Close the port.
ssize_t	Read (void *const buffer, size_t count)
	Read from the port.
ssize_t	ReadFull (void *const buffer, size_t count)
	Read the requested quantity of data from the port.
ssize_t	BytesAvailable ()
	Get the number of bytes waiting to be read at the port. Returns immediatly.
ssize_t	BytesAvailableWait ()
	Get the number of bytes waiting after blocking for the timeout.
ssize_t	Write (const void *const buffer, size_t count)
	Write data to the port.
void	Flush ()
	Flush the port's input and output buffers, discarding all data.
void	Drain ()
	Drain the port's input and output buffers.
std::string	GetStatus () const
	Get the status of the port (type, device, etc).
void	SetTimeout (Timeout timeout)
	Set the timeout value in milliseconds.
void	SetCanRead (bool canRead)
	Set the read permissions of the port.
void	SetCanWrite (bool canWrite)
	Set the write permissions of the port.
bool	IsOpen () const
	Check if the port is open.
Public Member Functions inherited from flexiport::Port
virtual	~Port ()
virtual ssize_t	ReadString (std::string &buffer)
	Read a string.
virtual ssize_t	ReadUntil (void *const buffer, size_t count, uint8_t terminator)
	Read data until a specified termination byte is received.
virtual ssize_t	ReadStringUntil (std::string &buffer, char terminator)
	Read a string until the specified termination character is received.
virtual ssize_t	ReadLine (char *const buffer, size_t count)
	Read a new-line terminated string of data.
virtual ssize_t	ReadLine (std::string &buffer)
	Read a new-line terminated string of data.
virtual ssize_t	Skip (size_t count)
	Dump data until the specified number of bytes have been read.
virtual ssize_t	SkipUntil (uint8_t terminator, unsigned int count)
	Read and dump data until the specified termination character has been seen count times.
virtual ssize_t	WriteFull (const void *const buffer, size_t count)
	Write all the data to the port.
virtual ssize_t	WriteString (const char *const buffer)
	Write a string to the port.
virtual ssize_t	WriteString (const std::string &buffer)
std::string	GetPortType () const
	Get the port type.
void	SetDebug (int debug)
	Set the debug level.
int	GetDebug () const
	Get the debug level.
virtual Timeout	GetTimeout () const
	Get the timeout.
virtual bool	IsBlocking () const
	Get the blocking property of the port.
virtual bool	CanRead () const
	Get the read permissions of the port.
virtual bool	CanWrite () const
	Get the write permissions of the port.

Additional Inherited Members
Protected Member Functions inherited from flexiport::Port
	Port ()
	Port (unsigned int debug, Timeout timeout, bool canRead, bool canWrite, bool alwaysOpen)
void	ProcessOptions (const std::map< std::string, std::string > &options)
Protected Attributes inherited from flexiport::Port
std::string	_type
unsigned int	_debug
Timeout	_timeout
bool	_canRead
bool	_canWrite
bool	_alwaysOpen

Detailed Description

Simulated port using a log file.

Uses a log file created by the LogWriterPort port type to simulate the data transfer over a Port object.

Note

Log files greater than 2GB in size are not supported.

The timer resolution under Windows is milliseconds, not microseconds. This may result in inaccurate replay when using a log file created on a POSIX-compatible operating system.

See the Port class documentation for how to use the common API.

Options

• file <string>
  • File name to read the log from. Two files will be created using this name and a suffix.
  • Default: port.log
• ignoretimes
  • Ignore time stamps in the log files. This means that all readable data is available instantly. It also overrides strictness level 2, if set, essentially turning it into strictness level 1.
  • Default: false
• strictness <integer>
  • Level of strictness to require:
    • 0: Writes are not checked against the log file.
    • 1: Writes are checked against the log file, but timing is not checked.
    • 2: Writes are checked against the log file. Timing is checked; if a write occurs earlier than did in the log file, it will cause an error. Jitter can be set to allow a margin of error.
  • Default: 0
• jitter <integer>
  • Margin of error (in milliseconds) to allow for write checking with strictness = 2.
  • Default: 100

Definition at line 82 of file logreaderport.h.

Constructor & Destructor Documentation

LogReaderPort()

flexiport::LogReaderPort::LogReaderPort

(

std::map< std::string, std::string >

options

)

~LogReaderPort()

flexiport::LogReaderPort::~LogReaderPort

(

)

Member Function Documentation

BytesAvailable()

ssize_t flexiport::LogReaderPort::BytesAvailable ( )

virtual

Get the number of bytes waiting to be read at the port. Returns immediatly.

Implements flexiport::Port.

BytesAvailableWait()

ssize_t flexiport::LogReaderPort::BytesAvailableWait ( )

virtual

Get the number of bytes waiting after blocking for the timeout.

Implements flexiport::Port.

Close()

void flexiport::LogReaderPort::Close ( )

virtual

Close the port.

Implements flexiport::Port.

Drain()

void flexiport::LogReaderPort::Drain ( )

virtual

Drain the port's input and output buffers.

Implements flexiport::Port.

Flush()

void flexiport::LogReaderPort::Flush ( )

virtual

Flush the port's input and output buffers, discarding all data.

Implements flexiport::Port.

GetStatus()

std::string flexiport::LogReaderPort::GetStatus ( ) const

virtual

Get the status of the port (type, device, etc).

Reimplemented from flexiport::Port.

IsOpen()

bool flexiport::LogReaderPort::IsOpen ( ) const

virtual

Check if the port is open.

Implements flexiport::Port.

Open()

void flexiport::LogReaderPort::Open ( )

virtual

Open the port.

Implements flexiport::Port.

Read()

ssize_t flexiport::LogReaderPort::Read ( void *const buffer, size_t count )

virtual

Read from the port.

Implements flexiport::Port.

ReadFull()

ssize_t flexiport::LogReaderPort::ReadFull ( void *const buffer, size_t count )

virtual

Read the requested quantity of data from the port.

Implements flexiport::Port.

SetCanRead()

void flexiport::LogReaderPort::SetCanRead ( bool canRead )

virtual

Set the read permissions of the port.

Implements flexiport::Port.

SetCanWrite()

void flexiport::LogReaderPort::SetCanWrite ( bool canWrite )

virtual

Set the write permissions of the port.

Implements flexiport::Port.

SetTimeout()

void flexiport::LogReaderPort::SetTimeout ( Timeout timeout )

virtual

Set the timeout value in milliseconds.

Implements flexiport::Port.

Write()

ssize_t flexiport::LogReaderPort::Write ( const void *const buffer, size_t count )

virtual

Write data to the port.

Implements flexiport::Port.

---

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

• /builddir/build/BUILD/flexiport-2.0.0-build/gbiggs-flexiport-1b6103d/include/flexiport/logreaderport.h