yarp::os::Face Class Reference

The initial point-of-contact with a port. More...

#include <yarp/os/Face.h>

Inheritance diagram for yarp::os::Face:

Public Member Functions
	Face ()=default
	Constructor.
virtual	~Face ()=default
	Destructor.
virtual bool	open (const Contact &address)=0
	Start listening to the given address.
virtual void	close ()=0
	Stop listening.
virtual InputProtocol *	read ()=0
	Block and wait for someone to talk to us.
virtual OutputProtocol *	write (const Contact &address)=0
	Try to reach out and talk to someone.
virtual Contact	getLocalAddress () const
	Get address after open(), if more specific that the address provided to open() - otherwise an invalid address is returned.

Detailed Description

The initial point-of-contact with a port.

Definition at line 19 of file Face.h.

Constructor & Destructor Documentation

Face()

yarp::os::Face::Face ( )

default

Constructor.

~Face()

virtual yarp::os::Face::~Face ( )

virtualdefault

Destructor.

Member Function Documentation

close()

virtual void yarp::os::Face::close ( )

pure virtual

Stop listening.

Implemented in yarp::os::impl::FakeFace, and yarp::os::impl::TcpFace.

getLocalAddress()

virtual Contact yarp::os::Face::getLocalAddress ( ) const

inlinevirtual

Get address after open(), if more specific that the address provided to open() - otherwise an invalid address is returned.

Returns

an address

Reimplemented in yarp::os::impl::TcpFace.

Definition at line 82 of file Face.h.

open()

virtual bool yarp::os::Face::open ( const Contact &  address )

pure virtual

Start listening to the given address.

Parameters

address

the parameters needed for listening. E.g. for TCP, this would contain a socket number.

Returns

true on success.

Implemented in yarp::os::impl::FakeFace, and yarp::os::impl::TcpFace.

read()

virtual InputProtocol * yarp::os::Face::read ( )

pure virtual

Block and wait for someone to talk to us.

Returns

a protocol object for talking to someone, or nullptr on failure.

Implemented in yarp::os::impl::FakeFace, and yarp::os::impl::TcpFace.

write()

virtual OutputProtocol * yarp::os::Face::write ( const Contact &  address )

pure virtual

Try to reach out and talk to someone.

Parameters

address

parameters describing destination. For example, for TCP this would contain a machine name/IP address, and a socket number.

Returns

a protocol object to talk with, or nullptr on failure.

Implemented in yarp::os::impl::FakeFace, and yarp::os::impl::TcpFace.

---

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

• src/libYARP_os/src/yarp/os/Face.h