BLOCXX_NAMESPACE::IOIFC Class Reference

#include <IOIFC.hpp>

Inheritance diagram for BLOCXX_NAMESPACE::IOIFC:

List of all members.

Public Member Functions
virtual	~IOIFC ()
virtual int	read (void *dataIn, int dataInLen, bool errorAsException=false)=0
	Read a specified number of bytes from the device that is exposing the IOIFC interface.
virtual int	write (const void *dataOut, int dataOutLen, bool errorAsException=false)=0
	Write a specified number of bytes to the device that is exposing the IOIFC interface.

---

Detailed Description

Definition at line 45 of file IOIFC.hpp.

---

Constructor & Destructor Documentation

BLOCXX_NAMESPACE::IOIFC::~IOIFC (   )  [virtual]

Definition at line 45 of file IOIFC.cpp.

---

Member Function Documentation

virtual int BLOCXX_NAMESPACE::IOIFC::read (  void *  dataIn, int  dataInLen, bool  errorAsException = false )  [pure virtual]

Read a specified number of bytes from the device that is exposing the IOIFC interface. Parameters: dataIn  A pointer to a location in memory to put the bytes that have been read. dataInLen  The number of bytes being requested from the device. errorAsException  If true and an error occurs durring the read operation, then throw an exception. Exceptions: An  exception will be thrown upon an error condition if errorAsException is true. Returns: The number of bytes actually read from the device, or -1 on error. Implemented in BLOCXX_NAMESPACE::PosixUnnamedPipe, BLOCXX_NAMESPACE::Socket, and BLOCXX_NAMESPACE::SocketBaseImpl. Referenced by BLOCXX_NAMESPACE::IOIFCStreamBuffer::buffer_from_device(), BLOCXX_NAMESPACE::UnnamedPipe::readAll(), and BLOCXX_NAMESPACE::UnnamedPipe::readInt().

virtual int BLOCXX_NAMESPACE::IOIFC::write (  const void *  dataOut, int  dataOutLen, bool  errorAsException = false )  [pure virtual]

Write a specified number of bytes to the device that is exposing the IOIFC interface. Parameters: dataOut  A pointer to a location in memory that contains the bytes that will be written to the device. dataOutLen  The length of the data pointed to by the dataOut param. errorAsException  If true and an error occurs durring the write operation, then throw an exception. Exceptions: An  exception will be thrown upon an error condition if errorAsException is true. Returns: The number of bytes actually written to the device. or -1 on error Implemented in BLOCXX_NAMESPACE::PosixUnnamedPipe, BLOCXX_NAMESPACE::Socket, and BLOCXX_NAMESPACE::SocketBaseImpl. Referenced by BLOCXX_NAMESPACE::IOIFCStreamBuffer::buffer_to_device(), BLOCXX_NAMESPACE::UnnamedPipe::writeInt(), and BLOCXX_NAMESPACE::UnnamedPipe::writeString().

---

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

• IOIFC.hpp
• IOIFC.cpp

---