Viam C++ SDK current
Loading...
Searching...
No Matches
Public Member Functions | List of all members
viam::sdk::Options Class Reference

Public Member Functions

 Options (unsigned int refresh_interval, boost::optional< ViamChannel::Options > channel_options)
 
std::chrono::seconds refresh_interval () const
 How often to refresh the status/parts of the robot, in seconds. If set to 0, the robot will not automatically refresh.
 
std::chrono::seconds check_every_interval () const
 
std::chrono::seconds reconnect_every_interval () const
 
Optionsset_check_every_interval (std::chrono::seconds interval)
 Sets how often to verify connectivity to the robot, in seconds. If set to 0, will not check, will default to the reconnect_every_interval_ value. Defaults to 0.
 
Optionsset_reconnect_every_interval (std::chrono::seconds interval)
 Sets how often to attempt to reconnect to the robot when disconnected. If set to 0, will not attempt to reconnect. Defaults to 0.
 
const boost::optional< ViamChannel::Options > & dial_options () const
 
const boost::optional< ViamChannel::Options > & channel_options () const
 

Member Function Documentation

◆ set_check_every_interval()

Options & viam::sdk::Options::set_check_every_interval ( std::chrono::seconds interval)

Sets how often to verify connectivity to the robot, in seconds. If set to 0, will not check, will default to the reconnect_every_interval_ value. Defaults to 0.

Note
Setting to a non-zero value is useful in modules but may result in delays shutting down client code

◆ set_reconnect_every_interval()

Options & viam::sdk::Options::set_reconnect_every_interval ( std::chrono::seconds interval)

Sets how often to attempt to reconnect to the robot when disconnected. If set to 0, will not attempt to reconnect. Defaults to 0.

Note
Setting to a non-zero value is useful in modules but may result in delays shutting down client code

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