I/O Device interface. More...

#include <iodevice.h>

+ Inheritance diagram for clan::IODevice:

Public Types

enum  SeekMode { seek_set, seek_cur, seek_end }
 Seeking modes. More...
 

Public Member Functions

 IODevice ()
 Constructs a null instance. More...
 
 IODevice (IODeviceProvider *provider)
 Constructs a IODevice. More...
 
 ~IODevice ()
 
IODevice duplicate ()
 Create a new IODevice referencing the same resource. More...
 
int get_position () const
 Returns the position in the data stream. More...
 
const IODeviceProviderget_provider () const
 Returns the provider for this object. More...
 
IODeviceProviderget_provider ()
 Returns the provider for this object. More...
 
int get_size () const
 Returns the size of data stream. More...
 
bool is_little_endian () const
 Returns true if the input source is in little endian mode. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
int peek (void *data, int len)
 Peek data from device (data is left in the buffer). More...
 
int read (void *data, int len, bool receive_all=true)
 Alias for receive(data, len, receive_all) More...
 
float read_float ()
 Reads a float from input source. More...
 
int16_t read_int16 ()
 Reads a signed 16 bit integer from input source. More...
 
int32_t read_int32 ()
 Reads a signed 32 bit integer from input source. More...
 
int64_t read_int64 ()
 Reads a signed 64 bit integer from input source. More...
 
int8_t read_int8 ()
 Reads a signed 8 bit integer from input source. More...
 
std::string read_string_a ()
 Reads a string from the input source. More...
 
std::string read_string_nul ()
 Reads a nul terminated string from the input source. More...
 
std::string read_string_text (const char *skip_initial_chars, const char *read_until_chars, bool allow_eof=true)
 Reads a string from the input source where the source is a text file. More...
 
uint16_t read_uint16 ()
 Reads an unsigned 16 bit integer from input source. More...
 
uint32_t read_uint32 ()
 Reads an unsigned 32 bit integer from input source. More...
 
uint64_t read_uint64 ()
 Reads an unsigned 64 bit integer from input source. More...
 
uint8_t read_uint8 ()
 Reads an unsigned 8 bit integer from input source. More...
 
int receive (void *data, int len, bool receive_all=true)
 Receive data from device. More...
 
bool seek (int position, SeekMode mode=seek_set)
 Seek in data stream. More...
 
int send (const void *data, int len, bool send_all=true)
 Send data to device. More...
 
void set_big_endian_mode ()
 Changes input data endianess to big endian mode. (Default is little endian) More...
 
void set_little_endian_mode ()
 Changes input data endianess to little endian mode. This is the default setting. More...
 
void set_system_mode ()
 Changes input data endianess to the local systems mode. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
int write (const void *data, int len, bool send_all=true)
 Alias for send(data, len, send_all) More...
 
void write_float (float data)
 Writes a float to output source. More...
 
void write_int16 (int16_t data)
 Writes a signed 16 bit integer to output source. More...
 
void write_int32 (int32_t data)
 Writes a signed 32 bit integer to output source. More...
 
void write_int64 (int64_t data)
 Writes a signed 64 bit integer to output source. More...
 
void write_int8 (int8_t data)
 Writes a signed 8 bit integer to output source. More...
 
void write_string_a (const std::string &str)
 Writes a string to the output source. More...
 
void write_string_nul (const std::string &str)
 Writes a nul terminated string to the output source. More...
 
void write_string_text (const std::string &str)
 Writes a text string to the output source. More...
 
void write_uint16 (uint16_t data)
 Writes an unsigned 16 bit integer to output source. More...
 
void write_uint32 (uint32_t data)
 Writes an unsigned 32 bit integer to output source. More...
 
void write_uint64 (uint64_t data)
 Writes an unsigned 64 bit integer to output source. More...
 
void write_uint8 (uint8_t data)
 Writes an unsigned 8 bit integer to output source. More...
 

Protected Attributes

std::shared_ptr< IODevice_Impl > impl
 

Detailed Description

I/O Device interface.

This class can store basic datatypes and retain portability (using the specified endian mode)
The supported datatypes are: int64_t, int32_t, int16_t and int8_t
The std::string datatype is supported - Using Size(int32_t), Charactor Data (std::string characters)

Constructor & Destructor Documentation

clan::IODevice::IODevice ( )

Constructs a null instance.

clan::IODevice::IODevice ( IODeviceProvider provider)

Constructs a IODevice.

Parameters
provider= IODevice Provider
clan::IODevice::~IODevice ( )

Member Function Documentation

IODevice clan::IODevice::duplicate ( )

Create a new IODevice referencing the same resource.

int clan::IODevice::get_position ( ) const

Returns the position in the data stream.

Returns -1 if the position is unknown.

Returns
The size (-1 if position is unknown)
const IODeviceProvider* clan::IODevice::get_provider ( ) const

Returns the provider for this object.

IODeviceProvider* clan::IODevice::get_provider ( )

Returns the provider for this object.

int clan::IODevice::get_size ( ) const

Returns the size of data stream.

Returns -1 if the size is unknown.

Returns
The size (-1 if size is unknown)
bool clan::IODevice::is_little_endian ( ) const

Returns true if the input source is in little endian mode.

Returns
true if little endian
bool clan::IODevice::is_null ( ) const
inline

Returns true if this object is invalid.

References impl.

int clan::IODevice::peek ( void *  data,
int  len 
)

Peek data from device (data is left in the buffer).

Parameters
dataData to receive
lenMaximum length of data to receive
Returns
size of data received.
int clan::IODevice::read ( void *  data,
int  len,
bool  receive_all = true 
)

Alias for receive(data, len, receive_all)

Parameters
dataData to receive
lenLength to receive
receive_alltrue to receive all the data. false = receive part of the data, if it would block
Returns
size of data received
float clan::IODevice::read_float ( )

Reads a float from input source.

Warning, this is not portable

Returns
The float read.
int16_t clan::IODevice::read_int16 ( )

Reads a signed 16 bit integer from input source.

Returns
The integer read.
int32_t clan::IODevice::read_int32 ( )

Reads a signed 32 bit integer from input source.

Returns
The integer read.
int64_t clan::IODevice::read_int64 ( )

Reads a signed 64 bit integer from input source.

Returns
The integer read.
int8_t clan::IODevice::read_int8 ( )

Reads a signed 8 bit integer from input source.

Returns
The integer read.
std::string clan::IODevice::read_string_a ( )

Reads a string from the input source.

The binary format expected in the input source is first an uint32 telling the length of the string, and then the string itself.

Returns
The string read.
std::string clan::IODevice::read_string_nul ( )

Reads a nul terminated string from the input source.

The binary format expected in the input source is a nul terminated string. (The NUL termintor is read, so that the file position is set after the NUL)

Returns
The string read.
std::string clan::IODevice::read_string_text ( const char *  skip_initial_chars,
const char *  read_until_chars,
bool  allow_eof = true 
)

Reads a string from the input source where the source is a text file.

After reading the input source up to "read_until_chars", the file position is set to the first character that was not read. If the file contains NUL characters, then the input is read up to the NUL character, and the file position is set AFTER the NUL)

Parameters
skip_initial_charsIgnore any of these characters at the start of the string. NULL = Do not ignore any characters
read_until_charsRead from the input until any of these characters are found. NULL = Read until the end of the file
allow_eofAllow EOF
Returns
The string read.
uint16_t clan::IODevice::read_uint16 ( )

Reads an unsigned 16 bit integer from input source.

Returns
The integer read.
uint32_t clan::IODevice::read_uint32 ( )

Reads an unsigned 32 bit integer from input source.

Returns
The integer read.
uint64_t clan::IODevice::read_uint64 ( )

Reads an unsigned 64 bit integer from input source.

Returns
The integer read.
uint8_t clan::IODevice::read_uint8 ( )

Reads an unsigned 8 bit integer from input source.

Returns
The integer read.
int clan::IODevice::receive ( void *  data,
int  len,
bool  receive_all = true 
)

Receive data from device.

Parameters
dataData to receive
lenLength to receive
receive_alltrue to receive all the data. false = receive part of the data, if it would block
Returns
size of data received
bool clan::IODevice::seek ( int  position,
SeekMode  mode = seek_set 
)

Seek in data stream.

Parameters
positionPosition to use (usage depends on the seek mode)
modeSeek mode
Returns
false = Failed
int clan::IODevice::send ( const void *  data,
int  len,
bool  send_all = true 
)

Send data to device.

If the device databuffer is too small, it will be extended (ie grow memory block size or file size)

Parameters
dataData to send
lenLength to send
send_alltrue to send all the data. false = send part of the data, if it would block
Returns
size of data sent
void clan::IODevice::set_big_endian_mode ( )

Changes input data endianess to big endian mode. (Default is little endian)

void clan::IODevice::set_little_endian_mode ( )

Changes input data endianess to little endian mode. This is the default setting.

void clan::IODevice::set_system_mode ( )

Changes input data endianess to the local systems mode.

void clan::IODevice::throw_if_null ( ) const

Throw an exception if this object is invalid.

int clan::IODevice::write ( const void *  data,
int  len,
bool  send_all = true 
)

Alias for send(data, len, send_all)

Parameters
dataData to send
lenLength to send
send_alltrue to send all the data. false = send part of the data, if it would block
Returns
size of data sent
void clan::IODevice::write_float ( float  data)

Writes a float to output source.

Parameters
data= Float to write

Warning, this is not portable.

void clan::IODevice::write_int16 ( int16_t  data)

Writes a signed 16 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_int32 ( int32_t  data)

Writes a signed 32 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_int64 ( int64_t  data)

Writes a signed 64 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_int8 ( int8_t  data)

Writes a signed 8 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_string_a ( const std::string str)

Writes a string to the output source.

Parameters
strString to write

The binary format written to the output source is first an uint32 telling the length of the string, and then the string itself.

void clan::IODevice::write_string_nul ( const std::string str)

Writes a nul terminated string to the output source.

Parameters
strString to write

The binary format written to the output source is the string content followed by the NUL character.

void clan::IODevice::write_string_text ( const std::string str)

Writes a text string to the output source.

Parameters
strString to write

The binary format written to the output source is the string content appended with a native newline. On Windows the newline is CR+LF sequence and on other platforms it is only LF character. This function is intended for use with text files.

void clan::IODevice::write_uint16 ( uint16_t  data)

Writes an unsigned 16 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_uint32 ( uint32_t  data)

Writes an unsigned 32 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_uint64 ( uint64_t  data)

Writes an unsigned 64 bit integer to output source.

Parameters
dataInteger to write
void clan::IODevice::write_uint8 ( uint8_t  data)

Writes an unsigned 8 bit integer to output source.

Parameters
dataInteger to write

Member Data Documentation

std::shared_ptr<IODevice_Impl> clan::IODevice::impl
protected

Referenced by is_null().


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