vapi::Dump< Req, Resp, Args > Class Template Reference

Class representing a dump request - zero or more identical responses to a single request message. More...

Inheritance diagram for vapi::Dump< Req, Resp, Args >:

Collaboration diagram for vapi::Dump< Req, Resp, Args >:

Public Types
using	resp_type = typename Msg< Resp >::shm_data_type

Public Member Functions
	Dump (Connection &con, Args... args, std::function< vapi_error_e(Dump< Req, Resp, Args... > &)> callback=nullptr)
	Dump (const Dump &)=delete
virtual	~Dump ()
virtual std::tuple< vapi_error_e, bool >	assign_response (vapi_msg_id_t id, void *shm_data)
vapi_error_e	execute ()
Msg< Req > &	get_request (void)
const Result_set< Resp > &	get_result_set (void) const
Public Member Functions inherited from vapi::Common_req
virtual	~Common_req ()
Connection &	get_connection ()
vapi_response_state_e	get_response_state (void) const

Friends
class	Connection

Detailed Description

template<typename Req, typename Resp, typename... Args>
class vapi::Dump< Req, Resp, Args >

Class representing a dump request - zero or more identical responses to a single request message.

Definition at line 498 of file vapi.hpp.

Member Typedef Documentation

resp_type

template<typename Req , typename Resp , typename... Args>

using vapi::Dump< Req, Resp, Args >::resp_type = typename Msg<Resp>::shm_data_type

Definition at line 833 of file vapi.hpp.

Constructor & Destructor Documentation

Dump() [1/2]

template<typename Req , typename Resp , typename... Args>

vapi::Dump< Req, Resp, Args >::Dump ( Connection &  con, Args...  args, std::function< vapi_error_e(Dump< Req, Resp, Args... > &)>  callback = nullptr  )

inline

Definition at line 788 of file vapi.hpp.

Dump() [2/2]

template<typename Req , typename Resp , typename... Args>

vapi::Dump< Req, Resp, Args >::Dump ( const Dump< Req, Resp, Args > &  )

delete

~Dump()

template<typename Req , typename Resp , typename... Args>

virtual vapi::Dump< Req, Resp, Args >::~Dump ( )

inlinevirtual

Definition at line 798 of file vapi.hpp.

Member Function Documentation

assign_response()

template<typename Req , typename Resp , typename... Args>

virtual std::tuple<vapi_error_e, bool> vapi::Dump< Req, Resp, Args >::assign_response ( vapi_msg_id_t  id, void *  shm_data  )

inlinevirtual

Implements vapi::Common_req.

Definition at line 802 of file vapi.hpp.

execute()

template<typename Req , typename Resp , typename... Args>

vapi_error_e vapi::Dump< Req, Resp, Args >::execute ( )

inline

Definition at line 823 of file vapi.hpp.

get_request()

template<typename Req , typename Resp , typename... Args>

Msg<Req>& vapi::Dump< Req, Resp, Args >::get_request ( void  )

inline

Definition at line 828 of file vapi.hpp.

get_result_set()

template<typename Req , typename Resp , typename... Args>

const Result_set<Resp>& vapi::Dump< Req, Resp, Args >::get_result_set ( void  ) const

inline

Definition at line 835 of file vapi.hpp.

Friends And Related Function Documentation

Connection

template<typename Req , typename Resp , typename... Args>

friend class Connection

friend

Definition at line 845 of file vapi.hpp.

---

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

• src/vpp-api/vapi/vapi.hpp