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

gRPC client implementation of a Discovery service. More...

#include <discovery_client.hpp>

+ Inheritance diagram for viam::sdk::impl::DiscoveryClient:

Public Types

using interface_type = Discovery
 

Public Member Functions

 DiscoveryClient (std::string name, std::shared_ptr< grpc::Channel > channel)
 
std::vector< ResourceConfigdiscover_resources (const ProtoStruct &extra) override
 Discover valid viam configuration of resources that are physically connected to your machine.
 
ProtoStruct do_command (const ProtoStruct &command) override
 Do an arbitrary command.
 
- Public Member Functions inherited from viam::sdk::Discovery
std::vector< ResourceConfigdiscover_resources ()
 Discover valid viam configuration of resources that are physically connected to your machine.
 
API api () const override
 Returns the API associated with a particular resource.
 
- Public Member Functions inherited from viam::sdk::Service
Name get_resource_name () const override
 Returns the Name for a particular resource.
 
- Public Member Functions inherited from viam::sdk::Resource
 Resource (std::string name)
 
virtual std::string name () const
 Return the resource's name.
 

Additional Inherited Members

- Protected Member Functions inherited from viam::sdk::Discovery
 Discovery (std::string name)
 
- Protected Member Functions inherited from viam::sdk::Service
 Service (std::string name)
 
- Protected Member Functions inherited from viam::sdk::Resource
Name get_resource_name (const std::string &type) const
 

Detailed Description

gRPC client implementation of a Discovery service.

Member Function Documentation

◆ discover_resources()

std::vector< ResourceConfig > viam::sdk::impl::DiscoveryClient::discover_resources ( const ProtoStruct & extra)
overridevirtual

Discover valid viam configuration of resources that are physically connected to your machine.

Parameters
extraAny additional arguments to the method.
Returns
array of potential viam configurations for hardware physically

Implements viam::sdk::Discovery.

◆ do_command()

ProtoStruct viam::sdk::impl::DiscoveryClient::do_command ( const ProtoStruct & command)
overridevirtual

Do an arbitrary command.

Parameters
commandFreeform fields that are service-specific.
Returns
Freeform result of the command.

Implements viam::sdk::Discovery.


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