DO NOT DERIVE FROM THIS CLASS, as the dtor has to call a virtual fct. More...
#include <IOIFCStreamBuffer.hpp>
Public Types | |
| enum | EDirectionFlag |
 Public Types inherited from BLOCXX_NAMESPACE::BaseStreamBuffer | |
| enum | EDirectionFlag { E_IN , E_OUT , E_IN_OUT } |
Public Member Functions | |
| IOIFCStreamBuffer (IOIFC *dev, int bufSize, const char *direction) BLOCXX_DEPRECATED | |
| IOIFCStreamBuffer (IOIFC *dev, EDirectionFlag direction=E_IN_OUT, int bufSize=64 *1024) | |
| void | setErrorAction (IOIFC::ErrorAction error_action) |
| virtual | ~IOIFCStreamBuffer () |
| virtual void | reset () |
| std::streambuf * | tie (std::streambuf *tied_buf) |
| Public Member Functions inherited from BLOCXX_NAMESPACE::BaseStreamBuffer | |
| BaseStreamBuffer (EDirectionFlag direction, size_t bufSize=BASE_BUF_SIZE) | |
| Create a base stream buffer. | |
| ~BaseStreamBuffer () | |
Private Member Functions | |
| IOIFCStreamBuffer (const IOIFCStreamBuffer &arg) | |
| IOIFCStreamBuffer & | operator= (const IOIFCStreamBuffer &arg) |
| virtual int | buffer_to_device (const char *c, int n) |
| Writes the buffer to the "device". | |
| virtual int | buffer_from_device (char *c, int n) |
| Fill the buffer from the "device". | |
Private Attributes | |
| IOIFC * | m_dev |
| std::streambuf * | m_tied_buf |
| IOIFC::ErrorAction | m_error_action |
Additional Inherited Members | |
| Protected Member Functions inherited from BLOCXX_NAMESPACE::BaseStreamBuffer | |
| int | underflow () |
| std::streamsize | xsputn (const char *s, std::streamsize n) |
| virtual int | overflow (int c) |
| virtual int | sync () |
| virtual void | initBuffers () |
| virtual void | initGetBuffer () |
| virtual void | initPutBuffer () |
Detailed Description
DO NOT DERIVE FROM THIS CLASS, as the dtor has to call a virtual fct.
Definition at line 51 of file IOIFCStreamBuffer.hpp.
Member Enumeration Documentation
◆ EDirectionFlag
Definition at line 60 of file BaseStreamBuffer.hpp.
Constructor & Destructor Documentation
◆ IOIFCStreamBuffer() [1/3]
| BLOCXX_NAMESPACE::IOIFCStreamBuffer::IOIFCStreamBuffer | ( | IOIFC * | dev, |
| int | bufSize, | ||
| const char * | direction ) |
Definition at line 63 of file IOIFCStreamBuffer.cpp.
◆ IOIFCStreamBuffer() [2/3]
| BLOCXX_NAMESPACE::IOIFCStreamBuffer::IOIFCStreamBuffer | ( | IOIFC * | dev, |
| EDirectionFlag | direction = E_IN_OUT, | ||
| int | bufSize = 64*1024 ) |
Definition at line 72 of file IOIFCStreamBuffer.cpp.
◆ ~IOIFCStreamBuffer()
|
virtual |
Definition at line 80 of file IOIFCStreamBuffer.cpp.
References BLOCXX_NAMESPACE::BaseStreamBuffer::sync().
◆ IOIFCStreamBuffer() [3/3]
|
private |
Member Function Documentation
◆ buffer_from_device()
Fill the buffer from the "device".
- Parameters
-
c A pointer to the beginning of the buffer n The number of bytes to be read into the buffer.
- Returns
- -1 if no bytes are able to be read from the "device" (for instance, end of input stream). Otherwise, return the number of bytes read into the buffer.
- Exceptions
-
IOException on failure.
Reimplemented from BLOCXX_NAMESPACE::BaseStreamBuffer.
Definition at line 105 of file IOIFCStreamBuffer.cpp.
References m_dev, m_error_action, m_tied_buf, BLOCXX_NAMESPACE::operator==(), and BLOCXX_NAMESPACE::IOIFC::read().
◆ buffer_to_device()
Writes the buffer to the "device".
- Parameters
-
c A pointer to the start of the buffer n the number of bytes to write
- Returns
- -1 if error, 0 if the entire buffer was written.
Reimplemented from BLOCXX_NAMESPACE::BaseStreamBuffer.
Definition at line 115 of file IOIFCStreamBuffer.cpp.
References m_dev, m_error_action, BLOCXX_NAMESPACE::operator==(), and BLOCXX_NAMESPACE::IOIFC::write().
◆ operator=()
|
private |
◆ reset()
|
virtual |
Definition at line 132 of file IOIFCStreamBuffer.cpp.
References BLOCXX_NAMESPACE::BaseStreamBuffer::initBuffers().
Referenced by BLOCXX_NAMESPACE::SocketBaseImpl::connect().
◆ setErrorAction()
| void BLOCXX_NAMESPACE::IOIFCStreamBuffer::setErrorAction | ( | IOIFC::ErrorAction | error_action | ) |
Definition at line 98 of file IOIFCStreamBuffer.cpp.
References m_error_action, and BLOCXX_NAMESPACE::operator==().
◆ tie()
| std::streambuf * BLOCXX_NAMESPACE::IOIFCStreamBuffer::tie | ( | std::streambuf * | tied_buf | ) |
Definition at line 91 of file IOIFCStreamBuffer.cpp.
References m_tied_buf, and BLOCXX_NAMESPACE::operator==().
Member Data Documentation
◆ m_dev
|
private |
Definition at line 68 of file IOIFCStreamBuffer.hpp.
Referenced by buffer_from_device(), and buffer_to_device().
◆ m_error_action
|
private |
Definition at line 70 of file IOIFCStreamBuffer.hpp.
Referenced by buffer_from_device(), buffer_to_device(), and setErrorAction().
◆ m_tied_buf
|
private |
Definition at line 69 of file IOIFCStreamBuffer.hpp.
Referenced by buffer_from_device(), and tie().
The documentation for this class was generated from the following files:
