Skip to content

Commit 319cebd

Browse files
committed
add throws to dial docstring
1 parent 72c2f86 commit 319cebd

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/viam/sdk/rpc/dial.hpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ class ViamChannel {
2222
/// how many times to attempt to connect and with what timeout.
2323
/// In general, use of this method is discouraged. `RobotClient::at_address(...)` is the
2424
/// preferred method to connect to a robot, and creates the channel itself.
25+
/// @throws Exception if it is unable to establish a connection to the provided URI
2526
static std::shared_ptr<ViamChannel> dial(const char* uri,
2627
const boost::optional<DialOptions>& options);
2728

@@ -30,6 +31,8 @@ class ViamChannel {
3031
// attempt and so uses the initial connection options.
3132
/// In general, use of this method is discouraged. `RobotClient::at_address(...)` is the
3233
/// preferred method to connect to a robot, and creates the channel itself.
34+
/// @throws Exception if it is unable to establish a connection to the provided URI within
35+
/// the given number of initial connection attempts
3336
static std::shared_ptr<ViamChannel> dial_initial(const char* uri,
3437
const boost::optional<DialOptions>& options);
3538

0 commit comments

Comments
 (0)