YARP
Yet Another Robot Platform
yarp::os::MpiP2PStream Class Reference

Implements communication via MPI point-to-point send/receive. More...

#include <mpi_carrier/include/yarp/os/MpiP2PStream.h>

+ Inheritance diagram for yarp::os::MpiP2PStream:

Detailed Description

Implements communication via MPI point-to-point send/receive.

Definition at line 25 of file MpiP2PStream.h.

Public Member Functions

 MpiP2PStream (std::string name, MpiComm *comm)
 
ssize_t read (Bytes &b) override
 Read a block of data from the stream. More...
 
void write (const Bytes &b) override
 Write a block of bytes to the stream. More...
 
void close () override
 Terminate the stream. More...
 
- Public Member Functions inherited from yarp::os::MpiStream
 MpiStream (std::string name, MpiComm *comm)
 
virtual ~MpiStream ()
 
bool isOk () const override
 Check if the stream is ok or in an error state. More...
 
void interrupt () override
 Interrupt the stream. More...
 
InputStreamgetInputStream () override
 Get an InputStream to read from. More...
 
OutputStreamgetOutputStream () override
 Get an OutputStream to write to. More...
 
const yarp::os::ContactgetLocalAddress () const override
 Get the address of the local side of the stream. More...
 
const yarp::os::ContactgetRemoteAddress () const override
 Get the address of the remote side of the stream. More...
 
void resetBuffer ()
 
void reset () override
 Reset the stream. More...
 
void beginPacket () override
 Mark the beginning of a logical packet. More...
 
void endPacket () override
 Mark the end of a logical packet (see beginPacket). More...
 
- Public Member Functions inherited from yarp::os::TwoWayStream
virtual ~TwoWayStream ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::InputStream
 InputStream ()
 Constructor. More...
 
virtual ~InputStream ()
 Destructor. More...
 
virtual void check ()
 Perform maintenance actions, if needed. More...
 
virtual int read ()
 Read and return a single byte. More...
 
virtual yarp::conf::ssize_t read (Bytes &b, size_t offset, yarp::conf::ssize_t len)
 Read a block of data from the stream. More...
 
virtual yarp::conf::ssize_t partialRead (yarp::os::Bytes &b)
 Like read, but solicit partial responses. More...
 
virtual bool setReadTimeout (double timeout)
 Set activity timeout. More...
 
std::string readLine (int terminal='\n', bool *success=nullptr)
 Read a block of text terminated with a specific marker (or EOF). More...
 
yarp::conf::ssize_t readFull (Bytes &b)
 Keep reading until buffer is full. More...
 
yarp::conf::ssize_t readDiscard (size_t len)
 Read and discard a fixed number of bytes. More...
 
virtual bool setReadEnvelopeCallback (readEnvelopeCallbackType callback, void *data)
 Install a callback that the InputStream will have to call when the envelope is read from a message in carriers that cannot be escaped. More...
 
- Public Member Functions inherited from yarp::os::OutputStream
virtual ~OutputStream ()
 Destructor. More...
 
virtual void write (char ch)
 Write a single byte to the stream. More...
 
virtual void write (const Bytes &b, int offset, int len)
 Write a block of bytes to the stream. More...
 
virtual void flush ()
 Make sure all pending write operations are finished. More...
 
virtual void writeLine (const char *data, int len)
 Write some text followed by a line feed. More...
 
virtual bool setWriteTimeout (double timeout)
 Set activity timeout. More...
 
virtual bool setTypeOfService (int tos)
 
virtual int getTypeOfService ()
 

Additional Inherited Members

- Public Types inherited from yarp::os::InputStream
typedef void(* readEnvelopeCallbackType) (void *, const yarp::os::Bytes &envelope)
 Callback type for setting the envelope from a message in carriers that cannot be escaped. More...
 
- Protected Attributes inherited from yarp::os::MpiStream
int readAvail
 
int readAt
 
char * readBuffer
 
bool terminate
 
std::string name
 
yarp::os::MpiCommcomm
 
yarp::os::Contact local
 
yarp::os::Contact remote
 

Constructor & Destructor Documentation

◆ MpiP2PStream()

yarp::os::MpiP2PStream::MpiP2PStream ( std::string  name,
MpiComm comm 
)
inline

Definition at line 27 of file MpiP2PStream.h.

Member Function Documentation

◆ close()

void yarp::os::MpiP2PStream::close ( )
inlineoverridevirtual

Terminate the stream.

Implements yarp::os::MpiStream.

Definition at line 34 of file MpiP2PStream.h.

◆ read()

ssize_t MpiP2PStream::read ( Bytes b)
overridevirtual

Read a block of data from the stream.

Should block and wait for data.

Parameters
b[out]the block of data to read to
Returns
the number of bytes read, or -1 upon error

Implements yarp::os::MpiStream.

Definition at line 18 of file MpiP2PStream.cpp.

◆ write()

void MpiP2PStream::write ( const Bytes b)
overridevirtual

Write a block of bytes to the stream.

Parameters
bthe bytes to write

Implements yarp::os::MpiStream.

Definition at line 72 of file MpiP2PStream.cpp.


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