YARP
Yet Another Robot Platform
MjpegStream Class Reference

#include <mjpeg_carrier/MjpegStream.h>

+ Inheritance diagram for MjpegStream:

Public Member Functions

 MjpegStream (TwoWayStream *delegate, bool autocompress)
 
virtual ~MjpegStream ()
 
yarp::os::InputStreamgetInputStream () override
 Get an InputStream to read from. More...
 
yarp::os::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...
 
bool isOk () const override
 Check if the stream is ok or in an error state. More...
 
void reset () override
 Reset the stream. More...
 
void close () override
 Terminate 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...
 
void write (const yarp::os::Bytes &b) override
 Write a block of bytes to the stream. More...
 
yarp::conf::ssize_t read (yarp::os::Bytes &b) override
 Read a block of data from the stream. More...
 
void interrupt () override
 Interrupt the stream. More...
 
bool setReadEnvelopeCallback (yarp::os::InputStream::readEnvelopeCallbackType callback, void *data) override
 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::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 (const char 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...
 
- 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...
 

Detailed Description

Definition at line 22 of file MjpegStream.h.

Constructor & Destructor Documentation

◆ MjpegStream()

MjpegStream::MjpegStream ( TwoWayStream *  delegate,
bool  autocompress 
)
inline

Definition at line 42 of file MjpegStream.h.

◆ ~MjpegStream()

virtual MjpegStream::~MjpegStream ( )
inlinevirtual

Definition at line 51 of file MjpegStream.h.

Member Function Documentation

◆ beginPacket()

void MjpegStream::beginPacket ( )
inlineoverridevirtual

Mark the beginning of a logical packet.

This is a unit that should be treated in an atomic fashion by YARP. If any part is corrupted, the whole should be dropped.

Implements yarp::os::TwoWayStream.

Definition at line 79 of file MjpegStream.h.

◆ close()

void MjpegStream::close ( )
inlineoverridevirtual

Terminate the stream.

Implements yarp::os::InputStream.

Definition at line 75 of file MjpegStream.h.

◆ endPacket()

void MjpegStream::endPacket ( )
inlineoverridevirtual

Mark the end of a logical packet (see beginPacket).

Implements yarp::os::TwoWayStream.

Definition at line 83 of file MjpegStream.h.

◆ getInputStream()

yarp::os::InputStream& MjpegStream::getInputStream ( )
inlineoverridevirtual

Get an InputStream to read from.

Returns
the InputStream associated with this object.

Implements yarp::os::TwoWayStream.

Definition at line 55 of file MjpegStream.h.

◆ getLocalAddress()

const yarp::os::Contact& MjpegStream::getLocalAddress ( ) const
inlineoverridevirtual

Get the address of the local side of the stream.

Returns
the address of the local side of the stream. The address will be tagged as invalid if the stream is not set up.

Implements yarp::os::TwoWayStream.

Definition at line 59 of file MjpegStream.h.

◆ getOutputStream()

yarp::os::OutputStream& MjpegStream::getOutputStream ( )
inlineoverridevirtual

Get an OutputStream to write to.

Returns
the InputStream associated with this object.

Implements yarp::os::TwoWayStream.

Definition at line 56 of file MjpegStream.h.

◆ getRemoteAddress()

const yarp::os::Contact& MjpegStream::getRemoteAddress ( ) const
inlineoverridevirtual

Get the address of the remote side of the stream.

Returns
the address of the remote side of the stream. The address will be tagged as invalid if the stream is not set up.

Implements yarp::os::TwoWayStream.

Definition at line 63 of file MjpegStream.h.

◆ interrupt()

void MjpegStream::interrupt ( )
inlineoverridevirtual

Interrupt the stream.

If the stream is currently in a blocked state, it must be unblocked.

Reimplemented from yarp::os::InputStream.

Definition at line 93 of file MjpegStream.h.

◆ isOk()

bool MjpegStream::isOk ( ) const
inlineoverridevirtual

Check if the stream is ok or in an error state.

Returns
true iff the stream is ok

Implements yarp::os::InputStream.

Definition at line 67 of file MjpegStream.h.

◆ read()

yarp::conf::ssize_t MjpegStream::read ( yarp::os::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::InputStream.

Definition at line 20 of file MjpegStream.cpp.

◆ reset()

void MjpegStream::reset ( )
inlineoverridevirtual

Reset the stream.

Implements yarp::os::TwoWayStream.

Definition at line 71 of file MjpegStream.h.

◆ setReadEnvelopeCallback()

bool MjpegStream::setReadEnvelopeCallback ( yarp::os::InputStream::readEnvelopeCallbackType  callback,
void *  data 
)
inlineoverridevirtual

Install a callback that the InputStream will have to call when the envelope is read from a message in carriers that cannot be escaped.

Parameters
callbackthe callback to execute
dataa pointer that should be passed as first parameter to the callback function
Returns
true iff the callback was installed.

Reimplemented from yarp::os::InputStream.

Definition at line 97 of file MjpegStream.h.

◆ write()

void MjpegStream::write ( const yarp::os::Bytes b)
overridevirtual

Write a block of bytes to the stream.

Parameters
bthe bytes to write

Implements yarp::os::OutputStream.

Definition at line 115 of file MjpegStream.cpp.


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