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

Public Member Functions

const boost::optional< Credentials > & credentials () const
 
const boost::optional< std::string > & entity () const
 
bool allows_insecure_downgrade () const
 
bool webrtc_disabled () const
 
const std::chrono::duration< float > & timeout () const
 
int initial_connection_attempts () const
 
std::chrono::duration< float > initial_connection_attempt_timeout () const
 
Optionsset_entity (boost::optional< std::string > entity)
 Set the URL to authenticate against.
 
Optionsset_credentials (boost::optional< Credentials > creds)
 Set Credentials for connecting to the robot.
 
Optionsset_allow_insecure_downgrade (bool allow)
 Set whether to allow the RPC connection to be downgraded to an insecure connection if detected. This is only used when credentials are not present.
 
Optionsset_webrtc_disabled (bool disable_webrtc)
 Set whether to bypass WebRTC and connect directly to the robot. This dials directly through grpc bypassing rust utils.
 
Optionsset_timeout (std::chrono::duration< float > timeout)
 Set the duration before the dial connection times out Set to 20sec to match _defaultOfferDeadline in goutils/rpc/wrtc_call_queue.go.
 
Optionsset_initial_connection_attempts (int attempts)
 Set the number of attempts to make when initially connecting to a robot If set to 0 or a negative integer, will attempt to reconnect forever.
 
Optionsset_initial_connection_attempt_timeout (std::chrono::duration< float > timeout)
 Set the timeout of connection attempts when initially dialing a robot Defaults to 20sec to match the default timeout duration.
 

Member Function Documentation

◆ set_webrtc_disabled()

Options & viam::sdk::ViamChannel::Options::set_webrtc_disabled ( bool disable_webrtc)

Set whether to bypass WebRTC and connect directly to the robot. This dials directly through grpc bypassing rust utils.

Remarks
Direct dialing should generally be done with a machine URI of the form <part>.<location>.local.viam.cloud:8080

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