NRP Core  1.4.1
PipeCommunication Class Reference

Creates a pipe, used for inter-process communication. Currently used just in Tests. More...

#include <pipe_communication.h>

Public Member Functions

 PipeCommunication ()
 
 ~PipeCommunication ()
 
ssize_t readP (void *buf, size_t count, u_int16_t tries=1, u_int16_t sleepSecs=0)
 Read from pipe. More...
 
ssize_t writeP (const void *buf, size_t count, u_int16_t tries=1, u_int16_t sleepSecs=0)
 Write to pipe. More...
 
void closeRead ()
 Close Read direction. More...
 
void closeWrite ()
 Close Write direction. More...
 
int readFd () const
 Get Read File Descriptor. More...
 
int writeFd () const
 Get Write File Descriptor. More...
 

Detailed Description

Creates a pipe, used for inter-process communication. Currently used just in Tests.

Constructor & Destructor Documentation

◆ PipeCommunication()

PipeCommunication::PipeCommunication ( )

◆ ~PipeCommunication()

PipeCommunication::~PipeCommunication ( )

Member Function Documentation

◆ closeRead()

void PipeCommunication::closeRead ( )

Close Read direction.

◆ closeWrite()

void PipeCommunication::closeWrite ( )

Close Write direction.

◆ readFd()

int PipeCommunication::readFd ( ) const

Get Read File Descriptor.

◆ readP()

ssize_t PipeCommunication::readP ( void *  buf,
size_t  count,
u_int16_t  tries = 1,
u_int16_t  sleepSecs = 0 
)

Read from pipe.

Parameters
bufbuffer to read to
countNumber of bytes to read
triesHow often to try to read from buffer
sleepSecsHow long to wait between retries
Returns
-1 on error, else number of read bytes

◆ writeFd()

int PipeCommunication::writeFd ( ) const

Get Write File Descriptor.

◆ writeP()

ssize_t PipeCommunication::writeP ( const void *  buf,
size_t  count,
u_int16_t  tries = 1,
u_int16_t  sleepSecs = 0 
)

Write to pipe.

Parameters
bufbuffer to write from
countNumber of bytes to write
triesHow often to try to write from buffer
sleepSecsHow long to wait between retries
Returns
-1 on error, else number of written bytes

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