A proxy connection buffering outgoing data into a memory region. More...
#include <bufferConnection.h>
Inheritance diagram for co::BufferConnection:
Collaboration diagram for co::BufferConnection:
Public Member Functions | |
| CO_API void | sendBuffer (ConnectionPtr connection) |
| uint64_t | getSize () const |
Protected Member Functions | |
| virtual void | readNB (void *, const uint64_t) |
| Start a read operation on the connection. | |
| virtual int64_t | readSync (void *, const uint64_t, const bool) |
| Finish reading data from the connection. | |
| virtual CO_API int64_t | write (const void *buffer, const uint64_t bytes) |
| Write data to the connection. | |
| virtual Notifier | getNotifier () const |
Detailed Description
A proxy connection buffering outgoing data into a memory region.
Definition at line 29 of file bufferConnection.h.
Member Function Documentation
| virtual Notifier co::BufferConnection::getNotifier | ( | ) | const [inline, protected, virtual] |
- Returns:
- the notifier signaling events on the connection.
Implements co::Connection.
Definition at line 47 of file bufferConnection.h.
| virtual void co::BufferConnection::readNB | ( | void * | buffer, |
| const uint64_t | bytes | ||
| ) | [inline, protected, virtual] |
Start a read operation on the connection.
This method is the low-level counterpart to recvNB().
This function returns immediately. The operation's Notifier will signal data availability, upon which readSync() should be used to finish the operation.
- Parameters:
-
buffer the buffer receiving the data. bytes the number of bytes to read.
- See also:
- readSync()
Implements co::Connection.
Definition at line 40 of file bufferConnection.h.
| virtual int64_t co::BufferConnection::readSync | ( | void * | buffer, |
| const uint64_t | bytes, | ||
| const bool | block | ||
| ) | [inline, protected, virtual] |
Finish reading data from the connection.
This method is the low-level counterpart to recvSync(). It may return with a partial read.
- Parameters:
-
buffer the buffer receiving the data. bytes the number of bytes to read. block internal WAR parameter, ignore it in the implementation unless you know exactly why not.
- Returns:
- the number of bytes read, or -1 upon error.
Implements co::Connection.
Definition at line 42 of file bufferConnection.h.
| virtual CO_API int64_t co::BufferConnection::write | ( | const void * | buffer, |
| const uint64_t | bytes | ||
| ) | [protected, virtual] |
Write data to the connection.
- Parameters:
-
buffer the buffer containing the message. bytes the number of bytes to write.
- Returns:
- the number of bytes written, or -1 upon error.
Implements co::Connection.
The documentation for this class was generated from the following file:
