YARP
Yet Another Robot Platform
ContactStyle.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_CONTACTSTYLE_H
11 #define YARP_OS_CONTACTSTYLE_H
12 
13 #include <yarp/os/api.h>
14 
15 #include <string>
16 
17 namespace yarp {
18 namespace os {
19 
27 {
28 public:
34  bool admin;
35 
39  bool quiet;
40 
45 
50  double timeout;
51 
57 
62 
66  bool persistent;
67 
73  {
74  OPENENDED = 0,
75  END_WITH_FROM_PORT = 1,
76  END_WITH_TO_PORT = 2,
77  NO_PERSISTENCE = 3
78  };
79 
85 
89  explicit ContactStyle();
90 };
91 
92 } // namespace os
93 } // namespace yarp
94 
95 #endif // YARP_OS_CONTACTSTYLE_H
yarp::os::ContactStyle::admin
bool admin
Ask recipient to treat message as administrative.
Definition: ContactStyle.h:34
yarp::os::ContactStyle
Preferences for how to communicate with a contact.
Definition: ContactStyle.h:27
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
yarp::os::ContactStyle::persistenceType
PersistenceType persistenceType
Specify kind of persistence to use.
Definition: ContactStyle.h:84
api.h
YARP_os_API
#define YARP_os_API
Definition: api.h:19
yarp::os::ContactStyle::expectReply
bool expectReply
Specify whether you expect a reply to a message.
Definition: ContactStyle.h:61
yarp::os::ContactStyle::quiet
bool quiet
Suppress all outputs and warnings.
Definition: ContactStyle.h:39
yarp::os::ContactStyle::persistent
bool persistent
Specify whether a requested connection should be persistent.
Definition: ContactStyle.h:66
yarp::os::ContactStyle::PersistenceType
PersistenceType
Persistence types, controlling the lifetime of a persistent connection.
Definition: ContactStyle.h:73
yarp::os::ContactStyle::carrier
std::string carrier
Request that communication be made using a particular carrier.
Definition: ContactStyle.h:56
yarp
The main, catch-all namespace for YARP.
Definition: environment.h:18
yarp::os::ContactStyle::verboseOnSuccess
bool verboseOnSuccess
Allow output on success.
Definition: ContactStyle.h:44
yarp::os::ContactStyle::timeout
double timeout
Set a timeout for communication (in units of seconds, fractional seconds allowed).
Definition: ContactStyle.h:50