Carrier for port communicating via MPI broadcast. More...

#include <mpi_carrier/MpiBcastCarrier.h>

Inheritance diagram for MpiBcastCarrier:

Public Member Functions
	MpiBcastCarrier ()

virtual	~MpiBcastCarrier ()

void	close () override
	Close the carrier. More...

Carrier *	create () const override
	Factory method. More...

void	createStream (bool sender) override

std::string	getName () const override
	Get the name of this connection type ("tcp", "mcast", "shmem", ...) More...

bool	supportReply () const override
	This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies. More...

bool	isBroadcast () const override
	Check if this carrier uses a broadcast mechanism. More...

void	prepareDisconnect () override
	Do cleanup and preparation for the coming disconnect, if necessary. More...

bool	expectReplyToHeader (yarp::os::ConnectionState &proto) override
	Process reply to header, if one is expected for this carrier. More...

bool	isActive () const override
	Check if carrier is alive and error free. More...

virtual bool	isElect () const

Public Member Functions inherited from MpiCarrier
	MpiCarrier ()

virtual	~MpiCarrier ()

bool	isConnectionless () const override
	Check if this carrier is connectionless (like udp, mcast) or connection based (like tcp). More...

bool	canEscape () const override
	Check if carrier can encode administrative messages, as opposed to just user data. More...

void	getHeader (yarp::os::Bytes &header) const override
	Provide 8 bytes describing this connection sufficiently to allow the other side of a connection to select it. More...

bool	checkHeader (const yarp::os::Bytes &header) override
	Given the first 8 bytes received on a connection, decide if this is the right carrier type to use for the rest of the connection. More...

bool	sendHeader (yarp::os::ConnectionState &proto) override
	Write a header appropriate to the carrier to the connection, followed by any carrier-specific data. More...

bool	expectSenderSpecifier (yarp::os::ConnectionState &proto) override
	Expect the name of the sending port. More...

bool	respondToHeader (yarp::os::ConnectionState &proto) override
	Respond to the header. More...

bool	expectReplyToHeader (yarp::os::ConnectionState &proto) override
	Process reply to header, if one is expected for this carrier. More...

bool	write (yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override
	Write a message. More...

bool	sendIndex (yarp::os::ConnectionState &proto, yarp::os::SizedWriter &writer) override

bool	expectIndex (yarp::os::ConnectionState &proto) override
	Expect a message header, if there is one for this carrier. More...

bool	sendAck (yarp::os::ConnectionState &proto) override
	Send an acknowledgement, if needed for this carrier. More...

bool	expectAck (yarp::os::ConnectionState &proto) override
	Receive an acknowledgement, if expected for this carrier. More...

Public Member Functions inherited from yarp::os::AbstractCarrier
void	setParameters (const yarp::os::Bytes &header) override
	Configure this carrier based on the first 8 bytes of the connection. More...

void	setCarrierParams (const yarp::os::Property &params) override
	Configure carrier from port administrative commands. More...

void	getCarrierParams (yarp::os::Property &params) const override
	Get carrier configuration and deliver it by port administrative commands. More...

bool	canAccept () const override
	Check if reading is implemented for this carrier. More...

bool	canOffer () const override
	Check if writing is implemented for this carrier. More...

bool	isTextMode () const override
	Check if carrier is textual in nature. More...

bool	requireAck () const override
	Check if carrier has flow control, requiring sent messages to be acknowledged by recipient. More...

bool	isLocal () const override
	Check if carrier operates within a single process. More...

std::string	toString () const override
	Get name of carrier. More...

bool	prepareSend (ConnectionState &proto) override
	Perform any initialization needed before writing on a connection. More...

bool	expectExtraHeader (ConnectionState &proto) override
	Receive any carrier-specific header. More...

bool	defaultSendHeader (ConnectionState &proto)
	Default implementation for the sendHeader method. More...

bool	defaultExpectIndex (ConnectionState &proto)
	Default implementation for the expectIndex method. More...

bool	defaultSendIndex (ConnectionState &proto, SizedWriter &writer)
	Default implementation for the sendIndex method. More...

bool	defaultExpectAck (ConnectionState &proto)
	Default implementation for the expectAck method. More...

bool	defaultSendAck (ConnectionState &proto)
	Default implementation for the sendAck method. More...

int	readYarpInt (ConnectionState &proto)
	Read 8 bytes and interpret them as a YARP number. More...

void	writeYarpInt (int n, ConnectionState &proto)
	Write `n` as an 8 bytes yarp number. More...

Public Member Functions inherited from yarp::os::Carrier
void	handleEnvelope (const std::string &envelope) override
	Carriers that do not distinguish data from administrative headers (i.e. More...

bool	isPush () const override
	Check if carrier is "push" or "pull" style. More...

virtual bool	reply (ConnectionState &proto, SizedWriter &writer)

virtual	~Carrier ()
	Destructor. More...

virtual std::string	getBootstrapCarrierName () const
	Get the name of the carrier that should be used prior to handshaking, if a port is registered with this carrier as its default carrier. More...

virtual int	connect (const Contact &src, const Contact &dest, const ContactStyle &style, int mode, bool reversed)
	Some carrier types may require special connection logic. More...

bool	modifiesIncomingData () const override
	Check if this carrier modifies incoming data through the Carrier::modifyIncomingData method. More...

ConnectionReader &	modifyIncomingData (ConnectionReader &reader) override
	Modify incoming payload data, if appropriate. More...

bool	acceptIncomingData (ConnectionReader &reader) override
	Determine whether incoming data should be accepted. More...

bool	modifiesOutgoingData () const override
	Check if this carrier modifies outgoing data through the Carrier::modifyOutgoingData method. More...

const PortWriter &	modifyOutgoingData (const PortWriter &writer) override
	Modify outgoing payload data, if appropriate. More...

bool	modifiesReply () const override
	Check if this carrier modifies outgoing data through the Carrier::modifyReply method. More...

PortReader &	modifyReply (PortReader &reader) override
	Modify reply payload data, if appropriate. More...

bool	acceptOutgoingData (const PortWriter &writer) override
	Determine whether outgoing data should be accepted. More...

virtual bool	configure (ConnectionState &proto)
	Give carrier a shot at looking at how the connection is set up. More...

virtual bool	configureFromProperty (yarp::os::Property &options)

void	setCarrierParams (const Property &params) override
	Configure carrier from port administrative commands. More...

void	getCarrierParams (Property &params) const override
	Get carrier configuration and deliver it by port administrative commands. More...

virtual yarp::os::Face *	createFace () const
	Create new Face object that the carrier needs. More...

Public Member Functions inherited from yarp::os::Connection
virtual	~Connection ()
	Destructor. More...

virtual bool	isValid () const
	Check if this object is really a connection, or just an empty placeholder. More...

virtual bool	isBareMode () const
	Check if carrier excludes type information from payload. More...

Additional Inherited Members
Protected Member Functions inherited from yarp::os::AbstractCarrier
int	getSpecifier (const Bytes &b) const

void	createStandardHeader (int specifier, yarp::os::Bytes &header) const

bool	sendConnectionStateSpecifier (ConnectionState &proto)

bool	sendSenderSpecifier (ConnectionState &proto)

Static Protected Member Functions inherited from yarp::os::AbstractCarrier
static int	interpretYarpNumber (const yarp::os::Bytes &b)

static void	createYarpNumber (int x, yarp::os::Bytes &header)

Protected Attributes inherited from MpiCarrier
MpiStream *	stream

MpiComm *	comm

std::string	port

std::string	name

std::string	other

std::string	route

std::string	target

Detailed Description

Carrier for port communicating via MPI broadcast.

Effective collective operations in the one-sender-multiple-receiver scenario. Allows only one-way communication (no replies).

Warning: Probably all processes terminate if one terminates without proper disconnect.; Seems to work, but still experimental.

Definition at line 29 of file MpiBcastCarrier.h.

Constructor & Destructor Documentation

◆ MpiBcastCarrier()

MpiBcastCarrier::MpiBcastCarrier ( )

inline

Definition at line 39 of file MpiBcastCarrier.h.

◆ ~MpiBcastCarrier()

MpiBcastCarrier::~MpiBcastCarrier ( )

virtual

Definition at line 17 of file MpiBcastCarrier.cpp.

Member Function Documentation

◆ close()

void MpiBcastCarrier::close ( )

overridevirtual

Close the carrier.

Implements MpiCarrier.

Definition at line 21 of file MpiBcastCarrier.cpp.

◆ create()

Carrier* MpiBcastCarrier::create ( ) const

inlineoverridevirtual

Factory method.

Get a new object of the same type as this one.

Returns: a new object of the same type as this one.

Implements MpiCarrier.

Definition at line 47 of file MpiBcastCarrier.h.

◆ createStream()

void MpiBcastCarrier::createStream ( bool sender )

overridevirtual

Implements MpiCarrier.

Definition at line 34 of file MpiBcastCarrier.cpp.

◆ expectReplyToHeader()

bool MpiBcastCarrier::expectReplyToHeader ( yarp::os::ConnectionState & proto )

inlineoverridevirtual

Process reply to header, if one is expected for this carrier.

Parameters

proto the protocol object, which tracks connection state

Returns: true on success, false on failure

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 67 of file MpiBcastCarrier.h.

◆ getName()

std::string MpiBcastCarrier::getName ( ) const

inlineoverridevirtual

Get the name of this connection type ("tcp", "mcast", "shmem", ...)

Returns: the name of this connection type

Implements MpiCarrier.

Definition at line 53 of file MpiBcastCarrier.h.

◆ isActive()

bool MpiBcastCarrier::isActive ( ) const

overridevirtual

Check if carrier is alive and error free.

Returns: true if carrier is active.

Reimplemented from yarp::os::AbstractCarrier.

Definition at line 100 of file MpiBcastCarrier.cpp.

◆ isBroadcast()

bool MpiBcastCarrier::isBroadcast ( ) const

inlineoverridevirtual

Check if this carrier uses a broadcast mechanism.

This flag is used to determine whether it is appropriate to send "kill" messages using a carrier or whether they should be sent "out-of-band"

Returns: true if carrier uses a broadcast mechanism.

Reimplemented from yarp::os::Carrier.

Definition at line 61 of file MpiBcastCarrier.h.

◆ isElect()

bool MpiBcastCarrier::isElect ( ) const

virtual

Definition at line 95 of file MpiBcastCarrier.cpp.

◆ prepareDisconnect()

void MpiBcastCarrier::prepareDisconnect ( )

overridevirtual

Do cleanup and preparation for the coming disconnect, if necessary.

Reimplemented from yarp::os::Carrier.

Definition at line 56 of file MpiBcastCarrier.cpp.

◆ supportReply()

bool MpiBcastCarrier::supportReply ( ) const

inlineoverridevirtual

This flag is used by YARP to determine whether the connection can carry RPC traffic, that is, messages with replies.

Returns: true if carrier supports replies

Implements MpiCarrier.

Definition at line 57 of file MpiBcastCarrier.h.

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

src/carriers/mpi_carrier/MpiBcastCarrier.h
src/carriers/mpi_carrier/MpiBcastCarrier.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MpiBcastCarrier()

◆ ~MpiBcastCarrier()

Member Function Documentation

◆ close()

◆ create()

◆ createStream()

◆ expectReplyToHeader()

◆ getName()

◆ isActive()

◆ isBroadcast()

◆ isElect()

◆ prepareDisconnect()

◆ supportReply()