apollo::common::ClientWrapper< Request, Response > 模板类 参考

Wrapper of cyber::Client which sends a topic with service name when SendRequst is invoked. 更多...

#include <client_wrapper.h>

apollo::common::ClientWrapper< Request, Response > 的协作图:

Public 成员函数
	ClientWrapper (const std::shared_ptr< cyber::Node > &node, const std::string &service_name)
std::shared_ptr< Response >	SendRequest (std::shared_ptr< Request > request, const std::chrono::seconds &timeout_s=std::chrono::seconds(5))
	Request the Service with a shared ptr Request type
std::shared_ptr< Response >	SendRequest (const Request &request, const std::chrono::seconds &timeout_s=std::chrono::seconds(5))
	Request the Service with a Request object
std::shared_future< Response >	AsyncSendRequest (std::shared_ptr< Request > request)
	Send Request shared ptr asynchronously
std::shared_future< Response >	AsyncSendRequest (const Request &request)
	Send Request object asynchronously
std::shared_future< Response >	AsyncSendRequest (std::shared_ptr< Request > request, std::function< void(std::shared_future< std::shared_ptr< Response > >)> &&cb)
	Send Request shared ptr asynchronously and invoke cb after we get response

详细描述

template<typename Request, typename Response>
class apollo::common::ClientWrapper< Request, Response >

Wrapper of cyber::Client which sends a topic with service name when SendRequst is invoked.

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

构造及析构函数说明

ClientWrapper()

template<typename Request , typename Response >

apollo::common::ClientWrapper< Request, Response >::ClientWrapper	(	const std::shared_ptr< cyber::Node > &	node,
		const std::string &	service_name
	)

在文件 client_wrapper.h 第 96 行定义.

    : client_(node->CreateClient<Request, Response>(service_name)),
      request_writer_(node->CreateWriter<Request>(service_name)) {}

成员函数说明

AsyncSendRequest() [1/3]

template<typename Request , typename Response >

std::shared_future< Response > apollo::common::ClientWrapper< Request, Response >::AsyncSendRequest

(

const Request &

request

)

Send Request object asynchronously

在文件 client_wrapper.h 第 126 行定义.

                            {
  auto response = client_->AsyncSendRequest(request);
  request_writer_->Write(request);
  return response;
}

AsyncSendRequest() [2/3]

template<typename Request , typename Response >

std::shared_future< Response > apollo::common::ClientWrapper< Request, Response >::AsyncSendRequest

(

std::shared_ptr< Request >

request

)

Send Request shared ptr asynchronously

在文件 client_wrapper.h 第 118 行定义.

                                    {
  auto response = client_->AsyncSendRequest(request);
  request_writer_->Write(request);
  return response;
}

AsyncSendRequest() [3/3]

template<typename Request , typename Response >

std::shared_future< Response > apollo::common::ClientWrapper< Request, Response >::AsyncSendRequest	(	std::shared_ptr< Request >	request,
		std::function< void(std::shared_future< std::shared_ptr< Response > >)> &&	cb
	)

Send Request shared ptr asynchronously and invoke cb after we get response

参数

request	Request shared ptr
cb	callback function after we get response

返回

std::shared_future<Response> a std::future shared ptr

在文件 client_wrapper.h 第 134 行定义.

                                                                       {
  auto response = client_->AsyncSendRequest(request, cb);
  request_writer_->Write(request);
  return response;
}

SendRequest() [1/2]

template<typename Request , typename Response >

std::shared_ptr< Response > apollo::common::ClientWrapper< Request, Response >::SendRequest	(	const Request &	request,
		const std::chrono::seconds &	timeout_s = std::chrono::seconds(5)
	)

Request the Service with a Request object

参数

request	Request object
timeout_s	request timeout, if timeout, response will be empty

返回

std::shared_ptr<Response> result of this request

在文件 client_wrapper.h 第 110 行定义.

                                                               {
  auto response = client_->SendRequest(request);
  request_writer_->Write(request);
  return response;
}

SendRequest() [2/2]

template<typename Request , typename Response >

std::shared_ptr< Response > apollo::common::ClientWrapper< Request, Response >::SendRequest	(	std::shared_ptr< Request >	request,
		const std::chrono::seconds &	timeout_s = std::chrono::seconds(5)
	)

Request the Service with a shared ptr Request type

参数

request	shared ptr of Request type
timeout_s	request timeout, if timeout, response will be empty

返回

std::shared_ptr<Response> result of this request

在文件 client_wrapper.h 第 102 行定义.

                                                                       {
  auto response = client_->SendRequest(request);
  request_writer_->Write(request);
  return response;
}

---

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

• modules/common/service_wrapper/client_wrapper.h