YARP
Yet Another Robot Platform
PortInfo.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3  * Copyright (C) 2006-2010 RobotCub Consortium
4  * All rights reserved.
5  *
6  * This software may be modified and distributed under the terms of the
7  * BSD-3-Clause license. See the accompanying LICENSE file for details.
8  */
9 
10 #ifndef YARP_OS_PORTINFO_H
11 #define YARP_OS_PORTINFO_H
12 
13 #include <yarp/os/api.h>
14 
15 #include <yarp/os/Vocab.h>
16 
17 #include <string>
18 
19 
20 namespace yarp {
21 namespace os {
22 
29 {
30 public:
34  explicit PortInfo();
35 
37  enum
38  {
40  PORTINFO_NULL = 0,
41 
43  PORTINFO_CONNECTION = yarp::os::createVocab('c', 'o', 'n', 'n'),
44 
46  PORTINFO_MISC = yarp::os::createVocab('m', 'i', 's', 'c')
47  };
48 
51  int tag;
52 
54  bool incoming;
55 
57  bool created;
58 
61 
64 
67 
70 
73 };
74 
75 } // namespace os
76 } // namespace yarp
77 
78 #endif // YARP_OS_PORTINFO_H
yarp::os::createVocab
constexpr yarp::conf::vocab32_t createVocab(char a, char b=0, char c=0, char d=0)
Definition: Vocab.h:22
YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG
#define YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(x)
Suppress MSVC C4251 warning for the declaration.
Definition: system.h:339
api.h
YARP_os_API
#define YARP_os_API
Definition: api.h:19
yarp::os::PortInfo::created
bool created
True if a connection is created, false if destroyed.
Definition: PortInfo.h:57
yarp::os::PortInfo
Information about a port connection or event.
Definition: PortInfo.h:29
yarp::os::PortInfo::carrierName
std::string carrierName
Name of protocol type, if releveant.
Definition: PortInfo.h:69
yarp::os::PortInfo::targetName
std::string targetName
Name of connection target, if any.
Definition: PortInfo.h:66
yarp::os::PortInfo::tag
int tag
Type of information.
Definition: PortInfo.h:51
yarp::os::PortInfo::incoming
bool incoming
True if a connection is incoming, false if outgoing.
Definition: PortInfo.h:54
yarp::os::PortInfo::portName
std::string portName
Name of port.
Definition: PortInfo.h:60
yarp::os::PortInfo::message
std::string message
A human-readable description of contents.
Definition: PortInfo.h:72
yarp
The main, catch-all namespace for YARP.
Definition: environment.h:18
Vocab.h
yarp::os::PortInfo::sourceName
std::string sourceName
Name of connection source, if any.
Definition: PortInfo.h:63