YARP
Yet Another Robot Platform
yarp::os::ContactStyle Class Reference

Preferences for how to communicate with a contact. More...

#include <yarp/os/ContactStyle.h>

Detailed Description

Preferences for how to communicate with a contact.

All fields have sensible defaults.

Definition at line 29 of file ContactStyle.h.

Public Types

enum  PersistenceType {
  OPENENDED = 0,
  END_WITH_FROM_PORT = 1,
  END_WITH_TO_PORT = 2,
  NO_PERSISTENCE = 3
}
 Persistence types, controlling the lifetime of a persistent connection. More...
 

Public Member Functions

 YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG (std::string) carrier
 Request that communication be made using a particular carrier. More...
 
 ContactStyle ()
 Constructor. More...
 

Public Attributes

bool admin
 Ask recipient to treat message as administrative. More...
 
bool quiet
 Suppress all outputs and warnings. More...
 
bool verboseOnSuccess
 Allow output on success. More...
 
double timeout
 Set a timeout for communication (in units of seconds, fractional seconds allowed). More...
 
bool expectReply
 Specify whether you expect a reply to a message. More...
 
bool persistent
 Specify whether a requested connection should be persistent. More...
 
PersistenceType persistenceType
 Specify kind of persistence to use. More...
 

Member Enumeration Documentation

◆ PersistenceType

Persistence types, controlling the lifetime of a persistent connection.

Enumerator
OPENENDED 
END_WITH_FROM_PORT 
END_WITH_TO_PORT 
NO_PERSISTENCE 

Definition at line 90 of file ContactStyle.h.

Constructor & Destructor Documentation

◆ ContactStyle()

yarp::os::ContactStyle::ContactStyle ( )
explicit

Constructor.

Sets all options to reasonable defaults.

Definition at line 13 of file ContactStyle.cpp.

Member Function Documentation

◆ YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG()

yarp::os::ContactStyle::YARP_SUPPRESS_DLL_INTERFACE_WARNING_ARG ( std::string  )

Request that communication be made using a particular carrier.

Member Data Documentation

◆ admin

bool yarp::os::ContactStyle::admin

Ask recipient to treat message as administrative.

All YARP ports support a basic API that this gives access to.

Definition at line 38 of file ContactStyle.h.

◆ expectReply

bool yarp::os::ContactStyle::expectReply

Specify whether you expect a reply to a message.

Definition at line 75 of file ContactStyle.h.

◆ persistenceType

PersistenceType yarp::os::ContactStyle::persistenceType

Specify kind of persistence to use.

Ignored if the persistent flag is inactive.

Definition at line 103 of file ContactStyle.h.

◆ persistent

bool yarp::os::ContactStyle::persistent

Specify whether a requested connection should be persistent.

Definition at line 82 of file ContactStyle.h.

◆ quiet

bool yarp::os::ContactStyle::quiet

Suppress all outputs and warnings.

Definition at line 45 of file ContactStyle.h.

◆ timeout

double yarp::os::ContactStyle::timeout

Set a timeout for communication (in units of seconds, fractional seconds allowed).

Definition at line 60 of file ContactStyle.h.

◆ verboseOnSuccess

bool yarp::os::ContactStyle::verboseOnSuccess

Allow output on success.

Definition at line 52 of file ContactStyle.h.


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