boost::rpc::client< Registry > Class Template Reference

#include <client.hpp>

Inheritance diagram for boost::rpc::client< Registry >:

List of all members.

---

Detailed Description

template<typename Registry>
class boost::rpc::client< Registry >

A client used to communicate with a rpc::registry_server over the network.

Parameters:

Registry

underlying Registry type used.

Public Types
typedef Registry::id_type	id_type
typedef Registry::archive_type	archive_type
typedef std::map< protocol::request_id_type, boost::shared_ptr< handler_base > >	requests_type
Public Member Functions
	client ()
	Initializes the client to communicate with the specified Boost.Asio endpoint.
	~client ()
	Stops the client service.
template<typename T>
handler_return< Registry, T >	operator() (async_returning_call< T > &call)
	Prepares and sends a complete rpc call.
Protected Member Functions
void	prepare_async_read ()
Protected Attributes
boost::asio::ip::tcp::socket	socket
Classes
class	handler_return

---

Constructor & Destructor Documentation

template<typename Registry>

boost::rpc::client< Registry >::client

(

)

[inline]

Initializes the client to communicate with the specified Boost.Asio endpoint.

Todo:

Handle protocol error.

---

Member Function Documentation

template<typename Registry>

template<typename T>

handler_return<Registry, T> boost::rpc::client< Registry >::operator()

(

async_returning_call< T > &

call

)

[inline]

Prepares and sends a complete rpc call.

The call is made in the following way:

• This method will lock the client's mutex, and spawn a handler for the call.
• It will then send the call header and marshal to the server
• Then, it will post the process_call method to the io_service, which will block.
• The handler will be returned via the handler_return class.
• The handler will notify the client about whether and how the handler was accepted.
• The client will store that in the handler's record and unlock the mutex.
• The process_call method can now finish the call.

---

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

• C:/Development/boost_sandbox/rpc/boost/rpc/client.hpp

---