YARP
Yet Another Robot Platform
Public Types | Public Member Functions | Public Attributes | List of all members
yarp::os::ContactStyle Class Reference
yarp::os OS-related functionalities » Communication Classes

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

#include <yarp/os/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

 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...
 
std::string carrier
 Request that communication be made using a particular carrier. 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...
 

Detailed Description

Preferences for how to communicate with a contact.

All fields have sensible defaults.

Definition at line 26 of file ContactStyle.h.

Member Enumeration Documentation

◆ PersistenceType

enum yarp::os::ContactStyle::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 72 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 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 34 of file ContactStyle.h.

◆ carrier

std::string yarp::os::ContactStyle::carrier

Request that communication be made using a particular carrier.

Definition at line 56 of file ContactStyle.h.

◆ expectReply

bool yarp::os::ContactStyle::expectReply

Specify whether you expect a reply to a message.

Definition at line 61 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 84 of file ContactStyle.h.

◆ persistent

bool yarp::os::ContactStyle::persistent

Specify whether a requested connection should be persistent.

Definition at line 66 of file ContactStyle.h.

◆ quiet

bool yarp::os::ContactStyle::quiet

Suppress all outputs and warnings.

Definition at line 39 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 50 of file ContactStyle.h.

◆ verboseOnSuccess

bool yarp::os::ContactStyle::verboseOnSuccess

Allow output on success.

Definition at line 44 of file ContactStyle.h.

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