YARP
Yet Another Robot Platform
ContactStyle.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_CONTACTSTYLE_H
8
#define YARP_OS_CONTACTSTYLE_H
9
10
#include <
yarp/os/api.h
>
11
12
#include <string>
13
14
namespace
yarp
{
15
namespace
os {
16
23
class
YARP_os_API
ContactStyle
24
{
25
public
:
31
bool
admin
;
32
36
bool
quiet
;
37
41
bool
verboseOnSuccess
;
42
47
double
timeout
;
48
53
YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG
(std::string)
carrier
;
54
58
bool
expectReply
;
59
63
bool
persistent
;
64
69
enum
PersistenceType
70
{
71
OPENENDED = 0,
72
END_WITH_FROM_PORT = 1,
73
END_WITH_TO_PORT = 2,
74
NO_PERSISTENCE = 3
75
};
76
81
PersistenceType
persistenceType
;
82
86
explicit
ContactStyle
();
87
};
88
89
}
// namespace os
90
}
// namespace yarp
91
92
#endif
// YARP_OS_CONTACTSTYLE_H
yarp::os::ContactStyle
Preferences for how to communicate with a contact.
Definition:
ContactStyle.h:24
yarp::os::ContactStyle::timeout
double timeout
Set a timeout for communication (in units of seconds, fractional seconds allowed).
Definition:
ContactStyle.h:47
yarp::os::ContactStyle::persistenceType
PersistenceType persistenceType
Specify kind of persistence to use.
Definition:
ContactStyle.h:81
yarp::os::ContactStyle::quiet
bool quiet
Suppress all outputs and warnings.
Definition:
ContactStyle.h:36
yarp::os::ContactStyle::carrier
std::string carrier
Request that communication be made using a particular carrier.
Definition:
ContactStyle.h:53
yarp::os::ContactStyle::verboseOnSuccess
bool verboseOnSuccess
Allow output on success.
Definition:
ContactStyle.h:41
yarp::os::ContactStyle::expectReply
bool expectReply
Specify whether you expect a reply to a message.
Definition:
ContactStyle.h:58
yarp::os::ContactStyle::admin
bool admin
Ask recipient to treat message as administrative.
Definition:
ContactStyle.h:31
yarp::os::ContactStyle::PersistenceType
PersistenceType
Persistence types, controlling the lifetime of a persistent connection.
Definition:
ContactStyle.h:70
yarp::os::ContactStyle::persistent
bool persistent
Specify whether a requested connection should be persistent.
Definition:
ContactStyle.h:63
yarp
The main, catch-all namespace for YARP.
Definition:
dirs.h:16
YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG
#define YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG(x)
Suppress MSVC C4251 warning for the declaration.
Definition:
system.h:336
api.h
YARP_os_API
#define YARP_os_API
Definition:
api.h:18
YARP
3.5.1
src
libYARP_os
src
yarp
os
ContactStyle.h
Generated on Sat Dec 25 2021 02:23:03 for YARP by
1.9.1