A descriptor that uses unix pipes.
You can get the 'other end' of the PipeDescriptor by calling OppositeEnd().
|
|
bool | Init () |
| | Initialize the PipeDescriptor.
|
| |
| PipeDescriptor * | OppositeEnd () |
| | Fetch the other end of the PipeDescriptor.
|
| |
| DescriptorHandle | ReadDescriptor () const |
| | Returns the read descriptor for this socket.
|
| |
| DescriptorHandle | WriteDescriptor () const |
| | Returns the write descriptor for this socket.
|
| |
| bool | Close () |
| | Close this PipeDescriptor.
|
| |
|
bool | CloseClient () |
| | Close the write portion of this PipeDescriptor.
|
| |
| virtual ssize_t | Send (const uint8_t *buffer, unsigned int size) |
| | Write a buffer to the descriptor.
|
| |
| virtual ssize_t | Send (IOQueue *data) |
| | Write data from an IOQueue to a descriptor.
|
| |
| virtual int | Receive (uint8_t *buffer, unsigned int size, unsigned int &data_read) |
| | Read data from this descriptor.
|
| |
| virtual bool | SetReadNonBlocking () |
| | Enable on non-blocking reads..
|
| |
| int | DataRemaining () const |
| | Find out how much data is left to read.
|
| |
|
bool | IsClosed () const |
| | Check if the descriptor is closed.
|
| |
| void | SetOnClose (OnCloseCallback *on_close) |
| | Set the callback to be run when the descriptor is closed.
|
| |
| OnCloseCallback * | TransferOnClose () |
| | Take ownership of the on_close callback.
|
| |
| void | SetOnData (ola::Callback0< void > *on_read) |
| | Set the callback to be run when data is available for reading.
|
| |
| void | SetOnWritable (ola::Callback0< void > *on_write) |
| | Set the callback to be run when the descriptor can be written to.
|
| |
| void | PerformRead () |
| | Called when there is data available on the descriptor.
|
| |
| void | PerformWrite () |
| | Called when the descriptor can be written to.
|
| |
| bool | ValidReadDescriptor () const |
| | Check if this file descriptor is valid.
|
| |
| bool | ValidWriteDescriptor () const |
| | Check if this file descriptor is valid.
|
| |
|
| bool | IsSocket () const |
| |
|
bool | SetNoSigPipe (DescriptorHandle fd) |
| | Disable SIGPIPE for this descriptor.
|
| |
|
|
typedef ola::SingleUseCallback0< void > | OnCloseCallback |
| |
|
static bool | SetNonBlocking (DescriptorHandle fd) |
| | Set a DescriptorHandle to non-blocking mode.
|
| |
◆ Close()
| bool ola::io::PipeDescriptor::Close |
( |
| ) |
|
|
virtual |
◆ IsSocket()
| bool ola::io::PipeDescriptor::IsSocket |
( |
| ) |
const |
|
inlineprotectedvirtual |
◆ OppositeEnd()
Fetch the other end of the PipeDescriptor.
- Returns
- A new PipeDescriptor or NULL if the descriptor wasn't initialized correctly. Its an error to call this more than once. Ownership of the returned PipeDescriptor is transferred to the caller.
◆ ReadDescriptor()
| DescriptorHandle ola::io::PipeDescriptor::ReadDescriptor |
( |
| ) |
const |
|
inlinevirtual |
◆ WriteDescriptor()
| DescriptorHandle ola::io::PipeDescriptor::WriteDescriptor |
( |
| ) |
const |
|
inlinevirtual |
The documentation for this class was generated from the following files: