|
|
void | close () |
| |
|
| ViamChannel (std::shared_ptr< GrpcChannel > channel, const char *path, void *runtime) |
| |
|
const std::shared_ptr< GrpcChannel > & | channel () const |
| |
|
| static std::shared_ptr< ViamChannel > | dial (const char *uri, const boost::optional< DialOptions > &options) |
| | Connects to a robot at the given URI address, using the provided dial options (or default options is none are provided). Ignores initial connection options specifying how many times to attempt to connect and with what timeout. In general, use of this method is discouraged. RobotClient::at_address(...) is the preferred method to connect to a robot, and creates the channel itself.
|
| |
| static std::shared_ptr< ViamChannel > | dial_initial (const char *uri, const boost::optional< DialOptions > &options) |
| |
◆ dial()
| static std::shared_ptr< ViamChannel > viam::sdk::ViamChannel::dial |
( |
const char * | uri, |
|
|
const boost::optional< DialOptions > & | options ) |
|
static |
Connects to a robot at the given URI address, using the provided dial options (or default options is none are provided). Ignores initial connection options specifying how many times to attempt to connect and with what timeout. In general, use of this method is discouraged. RobotClient::at_address(...) is the preferred method to connect to a robot, and creates the channel itself.
- Exceptions
-
| Exception | if it is unable to establish a connection to the provided URI |
◆ dial_initial()
| static std::shared_ptr< ViamChannel > viam::sdk::ViamChannel::dial_initial |
( |
const char * | uri, |
|
|
const boost::optional< DialOptions > & | options ) |
|
static |
In general, use of this method is discouraged. RobotClient::at_address(...) is the preferred method to connect to a robot, and creates the channel itself.
- Exceptions
-
| Exception | if it is unable to establish a connection to the provided URI within the given number of initial connection attempts |
The documentation for this class was generated from the following file:
