apollo::cyber::ClientBase类 参考

Base class of Client 更多...

#include <client_base.h>

类 apollo::cyber::ClientBase 继承关系图:

apollo::cyber::ClientBase 的协作图:

Public 成员函数
	ClientBase (const std::string &service_name)
	Construct a new Client Base object
virtual	~ClientBase ()
virtual void	Destroy ()=0
	Destroy the Client
const std::string &	ServiceName () const
	Get the service name
virtual bool	ServiceIsReady () const =0
	Ensure whether there is any Service named service_name_

Protected 成员函数
bool	WaitForServiceNanoseconds (std::chrono::nanoseconds time_out)

Protected 属性
std::string	service_name_

详细描述

Base class of Client

在文件 client_base.h 第 33 行定义.

构造及析构函数说明

ClientBase()

apollo::cyber::ClientBase::ClientBase ( const std::string &  service_name )

inlineexplicit

Construct a new Client Base object

参数

service_name

the service we can request

在文件 client_base.h 第 40 行定义.

      : service_name_(service_name) {}

~ClientBase()

virtual apollo::cyber::ClientBase::~ClientBase ( )

inlinevirtual

在文件 client_base.h 第 42 行定义.

{}

成员函数说明

Destroy()

virtual void apollo::cyber::ClientBase::Destroy ( )

pure virtual

Destroy the Client

在 apollo::cyber::Client< Request, Response > 内被实现.

ServiceIsReady()

virtual bool apollo::cyber::ClientBase::ServiceIsReady ( ) const

pure virtual

Ensure whether there is any Service named service_name_

在 apollo::cyber::Client< Request, Response > 内被实现.

ServiceName()

const std::string & apollo::cyber::ClientBase::ServiceName ( ) const

inline

Get the service name

在文件 client_base.h 第 52 行定义.

{ return service_name_; }

WaitForServiceNanoseconds()

bool apollo::cyber::ClientBase::WaitForServiceNanoseconds ( std::chrono::nanoseconds  time_out )

inlineprotected

在文件 client_base.h 第 62 行定义.

                                                                {
    bool has_service = false;
    auto step_duration = std::chrono::nanoseconds(5 * 1000 * 1000);
    while (time_out.count() > 0) {
      has_service = service_discovery::TopologyManager::Instance()
                        ->service_manager()
                        ->HasService(service_name_);
      if (!has_service) {
        std::this_thread::sleep_for(step_duration);
        time_out -= step_duration;
      } else {
        break;
      }
    }
    return has_service;
  }

类成员变量说明

service_name_

std::string apollo::cyber::ClientBase::service_name_

protected

在文件 client_base.h 第 60 行定义.

---

该类的文档由以下文件生成:

• cyber/service/client_base.h