Information about a port connection or event. More...

#include <yarp/os/PortInfo.h>

Public Types
enum	{ PORTINFO_NULL = 0, PORTINFO_CONNECTION = yarp::os::createVocab('c', 'o', 'n', 'n'), PORTINFO_MISC = yarp::os::createVocab('m', 'i', 's', 'c') }
	Possible tag values. More...

Public Member Functions
	PortInfo ()
	Constructor. More...

Public Attributes
int	tag
	Type of information. More...

bool	incoming
	True if a connection is incoming, false if outgoing. More...

bool	created
	True if a connection is created, false if destroyed. More...

std::string	portName
	Name of port. More...

std::string	sourceName
	Name of connection source, if any. More...

std::string	targetName
	Name of connection target, if any. More...

std::string	carrierName
	Name of protocol type, if releveant. More...

std::string	message
	A human-readable description of contents. More...

Detailed Description

Information about a port connection or event.

Definition at line 28 of file PortInfo.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Possible tag values.

Enumerator
PORTINFO_NULL	No information.
PORTINFO_CONNECTION	Information about an incoming or outgoing connection.
PORTINFO_MISC	Unspecified information.

Definition at line 37 of file PortInfo.h.

Constructor & Destructor Documentation

◆ PortInfo()

yarp::os::PortInfo::PortInfo ( )

explicit

Constructor.

Definition at line 13 of file PortInfo.cpp.

Member Data Documentation

◆ carrierName

std::string yarp::os::PortInfo::carrierName

Name of protocol type, if releveant.

Definition at line 69 of file PortInfo.h.

◆ created

bool yarp::os::PortInfo::created

True if a connection is created, false if destroyed.

Definition at line 57 of file PortInfo.h.

◆ incoming

bool yarp::os::PortInfo::incoming

True if a connection is incoming, false if outgoing.

Definition at line 54 of file PortInfo.h.

◆ message

std::string yarp::os::PortInfo::message

A human-readable description of contents.

Definition at line 72 of file PortInfo.h.

◆ portName

std::string yarp::os::PortInfo::portName

Name of port.

Definition at line 60 of file PortInfo.h.

◆ sourceName

std::string yarp::os::PortInfo::sourceName

Name of connection source, if any.

Definition at line 63 of file PortInfo.h.

◆ tag

int yarp::os::PortInfo::tag

Type of information.

PORTINFO_CONNECTION for information about an incoming or outgoing connection.

Definition at line 51 of file PortInfo.h.

◆ targetName

std::string yarp::os::PortInfo::targetName

Name of connection target, if any.

Definition at line 66 of file PortInfo.h.

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

src/libYARP_os/src/yarp/os/PortInfo.h
src/libYARP_os/src/yarp/os/PortInfo.cpp

Public Types

Public Member Functions

Public Attributes