UnixSockTwoWayStream Class Reference

A stream abstraction for unix socket communication. More...

#include <unix/UnixSockTwoWayStream.h>

Inheritance diagram for UnixSockTwoWayStream:

Public Member Functions
	UnixSockTwoWayStream (const std::string &_socketPath="")
	~UnixSockTwoWayStream () override
InputStream &	getInputStream () override
	Get an InputStream to read from.
OutputStream &	getOutputStream () override
	Get an OutputStream to write to.
const yarp::os::Contact &	getLocalAddress () const override
	Get the address of the local side of the stream.
const yarp::os::Contact &	getRemoteAddress () const override
	Get the address of the remote side of the stream.
void	interrupt () override
	Interrupt the stream.
void	close () override
	Terminate the stream.
yarp::conf::ssize_t	read (yarp::os::Bytes &b) override
	Read a block of data from the stream.
void	write (const yarp::os::Bytes &b) override
	Write a block of bytes to the stream.
bool	isOk () const override
	Check if the stream is ok or in an error state.
void	reset () override
	Reset the stream.
void	beginPacket () override
	Mark the beginning of a logical packet.
void	endPacket () override
	Mark the end of a logical packet (see beginPacket).
bool	open (bool sender=false)
void	setLocalAddress (yarp::os::Contact &_localAddress)
void	setRemoteAddress (yarp::os::Contact &_remoteAddress)
Public Member Functions inherited from yarp::os::TwoWayStream
virtual	~TwoWayStream ()
	Destructor.
Public Member Functions inherited from yarp::os::InputStream
	InputStream ()
	Constructor.
virtual	~InputStream ()
	Destructor.
virtual void	check ()
	Perform maintenance actions, if needed.
virtual int	read ()
	Read and return a single byte.
virtual yarp::conf::ssize_t	read (Bytes &b, size_t offset, yarp::conf::ssize_t len)
	Read a block of data from the stream.
virtual yarp::conf::ssize_t	partialRead (yarp::os::Bytes &b)
	Like read, but solicit partial responses.
virtual bool	setReadTimeout (double timeout)
	Set activity timeout.
std::string	readLine (const char terminal='\n', bool *success=nullptr)
	Read a block of text terminated with a specific marker (or EOF).
yarp::conf::ssize_t	readFull (Bytes &b)
	Keep reading until buffer is full.
yarp::conf::ssize_t	readDiscard (size_t len)
	Read and discard a fixed number of bytes.
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.
Public Member Functions inherited from yarp::os::OutputStream
virtual	~OutputStream ()
	Destructor.
virtual void	write (char ch)
	Write a single byte to the stream.
virtual void	write (const Bytes &b, int offset, int len)
	Write a block of bytes to the stream.
virtual void	flush ()
	Make sure all pending write operations are finished.
virtual void	writeLine (const char *data, int len)
	Write some text followed by a line feed.
virtual bool	setWriteTimeout (double timeout)
	Set activity timeout.
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.

Detailed Description

A stream abstraction for unix socket communication.

Definition at line 18 of file UnixSockTwoWayStream.h.

Constructor & Destructor Documentation

UnixSockTwoWayStream()

UnixSockTwoWayStream::UnixSockTwoWayStream

(

const std::string &

_socketPath = ""

)

Definition at line 24 of file UnixSockTwoWayStream.cpp.

~UnixSockTwoWayStream()

UnixSockTwoWayStream::~UnixSockTwoWayStream ( )

override

Definition at line 90 of file UnixSockTwoWayStream.cpp.

Member Function Documentation

beginPacket()

void UnixSockTwoWayStream::beginPacket ( )

overridevirtual

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 195 of file UnixSockTwoWayStream.cpp.

close()

void UnixSockTwoWayStream::close ( )

overridevirtual

Terminate the stream.

Implements yarp::os::TwoWayStream.

Definition at line 131 of file UnixSockTwoWayStream.cpp.

endPacket()

void UnixSockTwoWayStream::endPacket ( )

overridevirtual

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

Implements yarp::os::TwoWayStream.

Definition at line 199 of file UnixSockTwoWayStream.cpp.

getInputStream()

InputStream & UnixSockTwoWayStream::getInputStream ( )

overridevirtual

Get an InputStream to read from.

Returns

the InputStream associated with this object.

Implements yarp::os::TwoWayStream.

Definition at line 95 of file UnixSockTwoWayStream.cpp.

getLocalAddress()

const Contact & UnixSockTwoWayStream::getLocalAddress ( ) const

overridevirtual

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 105 of file UnixSockTwoWayStream.cpp.

getOutputStream()

OutputStream & UnixSockTwoWayStream::getOutputStream ( )

overridevirtual

Get an OutputStream to write to.

Returns

the InputStream associated with this object.

Implements yarp::os::TwoWayStream.

Definition at line 100 of file UnixSockTwoWayStream.cpp.

getRemoteAddress()

const Contact & UnixSockTwoWayStream::getRemoteAddress ( ) const

overridevirtual

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 110 of file UnixSockTwoWayStream.cpp.

interrupt()

void UnixSockTwoWayStream::interrupt ( )

overridevirtual

Interrupt the stream.

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

Reimplemented from yarp::os::InputStream.

Definition at line 125 of file UnixSockTwoWayStream.cpp.

isOk()

bool UnixSockTwoWayStream::isOk ( ) const

overridevirtual

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

Returns

true iff the stream is ok

Implements yarp::os::TwoWayStream.

Definition at line 186 of file UnixSockTwoWayStream.cpp.

open()

bool UnixSockTwoWayStream::open

(

bool

sender = false

)

Definition at line 29 of file UnixSockTwoWayStream.cpp.

read()

yarp::conf::ssize_t UnixSockTwoWayStream::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 152 of file UnixSockTwoWayStream.cpp.

reset()

void UnixSockTwoWayStream::reset ( )

overridevirtual

Reset the stream.

Implements yarp::os::TwoWayStream.

Definition at line 191 of file UnixSockTwoWayStream.cpp.

setLocalAddress()

void UnixSockTwoWayStream::setLocalAddress

(

yarp::os::Contact &

_localAddress

)

Definition at line 115 of file UnixSockTwoWayStream.cpp.

setRemoteAddress()

void UnixSockTwoWayStream::setRemoteAddress

(

yarp::os::Contact &

_remoteAddress

)

Definition at line 120 of file UnixSockTwoWayStream.cpp.

write()

void UnixSockTwoWayStream::write ( const yarp::os::Bytes &  b )

overridevirtual

Write a block of bytes to the stream.

Parameters

b	the bytes to write

Implements yarp::os::OutputStream.

Definition at line 170 of file UnixSockTwoWayStream.cpp.

---

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

• src/carriers/unix/UnixSockTwoWayStream.h
• src/carriers/unix/UnixSockTwoWayStream.cpp