#include <mrpt/synch/CPipe.h>
Public Types | |
enum | TSeekOrigin { sFromBeginning = 0, sFromCurrent = 1, sFromEnd = 2 } |
Used in CStream::Seek. More... | |
Public Member Functions | |
CPipeBaseEndPoint () | |
virtual | ~CPipeBaseEndPoint () |
CPipeBaseEndPoint (const std::string &serialized) | |
De-serializes one end-point description, for example, from a parent process. More... | |
std::string | serialize () |
Converts the end-point into a string suitable for reconstruction at a child process. More... | |
bool | isOpen () const |
Returns false if the pipe was closed due to some error. More... | |
void | close () |
Closes the pipe (normally not needed to be called by users, automatically done at destructor) More... | |
size_t | ReadBuffer (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer. More... | |
template<typename T > | |
size_t | ReadBufferFixEndianness (T *ptr, size_t ElementCount) |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture. More... | |
virtual size_t | ReadBufferImmediate (void *Buffer, size_t Count) |
Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream). More... | |
void | WriteBuffer (const void *Buffer, size_t Count) |
Writes a block of bytes to the stream from Buffer. More... | |
template<typename T > | |
void | WriteBufferFixEndianness (const T *ptr, size_t ElementCount) |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness). More... | |
virtual uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning)=0 |
Introduces a pure virtual method for moving to a specified position in the streamed resource. More... | |
void | WriteObject (const CSerializable *o) |
Writes an object to the stream. More... | |
CSerializablePtr | ReadObject () |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object. More... | |
void | ReadObject (CSerializable *existingObj) |
Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in. More... | |
CStream & | operator<< (const CSerializablePtr &pObj) |
Write an object to a stream in the binary MRPT format. More... | |
CStream & | operator<< (const CSerializable &obj) |
Write an object to a stream in the binary MRPT format. More... | |
CStream & | operator>> (CSerializablePtr &pObj) |
CStream & | operator>> (CSerializable &obj) |
template<typename STORED_TYPE , typename CAST_TO_TYPE > | |
void | ReadAsAndCastTo (CAST_TO_TYPE &read_here) |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast. More... | |
virtual int | printf (const char *fmt,...) MRPT_printf_format_check(2 |
Writes a string to the stream in a textual form. More... | |
template<typename CONTAINER_TYPE > | |
virtual int void | printf_vector (const char *fmt, const CONTAINER_TYPE &V, char separator=',') |
Prints a vector in the format [A,B,C,...] using CStream::printf, and the fmt string for each vector element T . More... | |
void | sendMessage (const utils::CMessage &msg) |
Send a message to the device. More... | |
bool | receiveMessage (utils::CMessage &msg) |
Tries to receive a message from the device. More... | |
bool | getline (std::string &out_str) |
Reads from the stream until a ' ' character is found ('' characters are ignored). More... | |
Public Attributes | |
unsigned int | timeout_read_start_us |
(Default=0) Timeout for read operations: microseconds (us) to wait for the first byte. 0 means infinite timeout. More... | |
unsigned int | timeout_read_between_us |
(Default=0) Timeout between burst reads operations: microseconds (us) to wait between two partial reads inside one large read. 0 means infinite timeout. More... | |
Protected Member Functions | |
virtual size_t | Read (void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for reading from the stream. More... | |
virtual size_t | Write (const void *Buffer, size_t Count) MRPT_OVERRIDE |
Introduces a pure virtual method responsible for writing to the stream. More... | |
virtual uint64_t | Seek (uint64_t Offset, CStream::TSeekOrigin Origin=sFromBeginning) MRPT_OVERRIDE |
Without effect in this class. More... | |
virtual uint64_t | getTotalBytesCount () MRPT_OVERRIDE |
Without effect in this class. More... | |
virtual uint64_t | getPosition () MRPT_OVERRIDE |
Without effect in this class. More... | |
template<bool EXISTING_OBJ> | |
void | internal_ReadObject (CSerializablePtr &newObj, CSerializable *existingObj=NULL) |
A common template code for both versions of CStream::ReadObject() More... | |
Protected Attributes | |
int | m_pipe_file |
Friends | |
class | CPipe |
|
inherited |
mrpt::synch::CPipeBaseEndPoint::CPipeBaseEndPoint | ( | ) |
|
virtual |
|
explicit |
De-serializes one end-point description, for example, from a parent process.
void mrpt::synch::CPipeBaseEndPoint::close | ( | ) |
Closes the pipe (normally not needed to be called by users, automatically done at destructor)
|
inherited |
Reads from the stream until a '
' character is found ('' characters are ignored).
|
protectedvirtual |
Without effect in this class.
Implements mrpt::utils::CStream.
|
protectedvirtual |
Without effect in this class.
Implements mrpt::utils::CStream.
|
protectedinherited |
A common template code for both versions of CStream::ReadObject()
|
inline |
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
Write an object to a stream in the binary MRPT format.
|
inherited |
|
inherited |
|
virtualinherited |
Writes a string to the stream in a textual form.
Referenced by mrpt::graphslam::TUncertaintyPath< GRAPH_T >::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TInsertionOptions::dumpToTextStream(), mrpt::graphslam::deciders::CFixedIntervalsNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::deciders::CRangeScanOps< GRAPH_T >::TParams::dumpToTextStream(), mrpt::maps::COctoMapBase< OCTREE, OCTREE_NODE >::TLikelihoodOptions::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaERD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::OptimizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CICPCriteriaNRD< GRAPH_T >::TParams::dumpToTextStream(), mrpt::graphslam::optimizers::CLevMarqGSO< GRAPH_T >::GraphVisualizationParams::dumpToTextStream(), mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLaserParams::dumpToTextStream(), and mrpt::graphslam::deciders::CLoopCloserERD< GRAPH_T >::TLoopClosureParams::dumpToTextStream().
|
inlineinherited |
|
protectedvirtual |
Introduces a pure virtual method responsible for reading from the stream.
Implements mrpt::utils::CStream.
|
inlineinherited |
Read a value from a stream stored in a type different of the target variable, making the conversion via static_cast.
Useful for coding backwards compatible de-serialization blocks
Definition at line 194 of file CStream.h.
References MRPT_printf_format_check.
|
inherited |
Reads a block of bytes from the stream into Buffer.
std::exception | On any error, or if ZERO bytes are read. |
|
inlineinherited |
Reads a sequence of elemental datatypes, taking care of reordering their bytes from the MRPT stream standard (little endianness) to the format of the running architecture.
ElementCount | The number of elements (not bytes) to read. |
ptr | A pointer to the first output element in an array (or std::vector<>, etc...). |
std::exception | On any error, or if ZERO bytes are read. |
Definition at line 95 of file CStream.h.
References mrpt::mrpt::utils::reverseBytesInPlace().
Referenced by mrpt::math::operator>>().
|
inlinevirtualinherited |
Reads a block of bytes from the stream into Buffer, and returns the amound of bytes actually read, without waiting for more extra bytes to arrive (just those already enqued in the stream).
Note that this method will fallback to ReadBuffer() in most CStream classes but in some hardware-related classes.
std::exception | On any error, or if ZERO bytes are read. |
Reimplemented in mrpt::hwdrivers::CInterfaceFTDI.
|
inherited |
Reads an object from stream, its class determined at runtime, and returns a smart pointer to the object.
std::exception | On I/O error or undefined class. |
mrpt::utils::CExceptionEOF | On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead. |
Referenced by mrpt::utils::mrpt_recv_from_zmq(), mrpt::utils::mrpt_recv_from_zmq_into(), and mrpt::math::operator>>().
|
inherited |
Reads an object from stream, where its class must be the same as the supplied object, where the loaded object will be stored in.
std::exception | On I/O error or different class found. |
mrpt::utils::CExceptionEOF | On an End-Of-File condition found at a correct place: an EOF that abruptly finishes in the middle of one object raises a plain std::exception instead. |
|
inherited |
Tries to receive a message from the device.
std::exception | On communication errors |
|
protectedvirtual |
Without effect in this class.
|
pure virtualinherited |
Introduces a pure virtual method for moving to a specified position in the streamed resource.
he Origin parameter indicates how to interpret the Offset parameter. Origin should be one of the following values:
Implemented in mrpt::utils::CClientTCPSocket, mrpt::utils::CFileStream, mrpt::utils::CFileOutputStream, mrpt::utils::CFileGZInputStream, mrpt::utils::CMemoryStream, mrpt::utils::CFileInputStream, and mrpt::utils::CStdOutStream.
|
inherited |
Send a message to the device.
Note that only the low byte from the "type" field will be used.
For frames of size < 255 the frame format is an array of bytes in this order:
For frames of size > 255 the frame format is an array of bytes in this order:
std::exception | On communication errors |
std::string mrpt::synch::CPipeBaseEndPoint::serialize | ( | ) |
Converts the end-point into a string suitable for reconstruction at a child process.
This invalidates this object, since only one real end-point can exist at once.
|
protectedvirtual |
Introduces a pure virtual method responsible for writing to the stream.
Write attempts to write up to Count bytes to Buffer, and returns the number of bytes actually written.
Implements mrpt::utils::CStream.
|
inherited |
Writes a block of bytes to the stream from Buffer.
std::exception | On any error |
Referenced by mrpt::utils::mrpt_recv_from_zmq_buf().
|
inlineinherited |
Writes a sequence of elemental datatypes, taking care of reordering their bytes from the running architecture to MRPT stream standard (little endianness).
ElementCount | The number of elements (not bytes) to write. |
ptr | A pointer to the first input element in an array (or std::vector<>, etc...). Example of usage: vector<float> vec = ... uint32_t N = vec.size(); s << N if (N) s.WriteBufferFixEndianness<float>(&vec[0],N); |
std::exception | On any error |
Definition at line 139 of file CStream.h.
References mrpt::utils::operator<<(), and mrpt::utils::operator>>().
|
inherited |
Writes an object to the stream.
Referenced by mrpt::utils::mrpt_send_to_zmq().
unsigned int mrpt::synch::CPipeBaseEndPoint::timeout_read_between_us |
Page generated by Doxygen 1.8.13 for MRPT 1.5.3 at Mon Oct 30 10:27:08 UTC 2017 |