YARP
Yet Another Robot Platform
PortInfo.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3  * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef YARP_OS_PORTINFO_H
8 #define YARP_OS_PORTINFO_H
9 
10 #include <yarp/os/api.h>
11 
12 #include <yarp/os/Vocab.h>
13 
14 #include <string>
15 
16 
17 namespace yarp {
18 namespace os {
19 
26 {
27 public:
31  explicit PortInfo();
32 
34  enum
35  {
37  PORTINFO_NULL = 0,
38 
40  PORTINFO_CONNECTION = yarp::os::createVocab32('c', 'o', 'n', 'n'),
41 
43  PORTINFO_MISC = yarp::os::createVocab32('m', 'i', 's', 'c')
44  };
45 
48  int tag;
49 
51  bool incoming;
52 
54  bool created;
55 
58 
61 
64 
67 
70 };
71 
72 } // namespace os
73 } // namespace yarp
74 
75 #endif // YARP_OS_PORTINFO_H
Information about a port connection or event.
Definition: PortInfo.h:26
std::string targetName
Name of connection target, if any.
Definition: PortInfo.h:63
std::string carrierName
Name of protocol type, if releveant.
Definition: PortInfo.h:66
bool incoming
True if a connection is incoming, false if outgoing.
Definition: PortInfo.h:51
std::string message
A human-readable description of contents.
Definition: PortInfo.h:69
bool created
True if a connection is created, false if destroyed.
Definition: PortInfo.h:54
std::string portName
Name of port.
Definition: PortInfo.h:57
int tag
Type of information.
Definition: PortInfo.h:48
std::string sourceName
Name of connection source, if any.
Definition: PortInfo.h:60
constexpr yarp::conf::vocab32_t createVocab32(char a, char b=0, char c=0, char d=0)
Create a vocab from chars.
Definition: Vocab.h:28
The main, catch-all namespace for YARP.
Definition: dirs.h:16
#define YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(x)
Suppress MSVC C4251 warning for the declaration.
Definition: system.h:336
#define YARP_os_API
Definition: api.h:18