SAGA C++ API 1.5.3

saga::rpc::rpc Class Reference

This class represents a remote function handle, which can be called (repeatedly), and returns the result of the respective remote procedure invocation. More...

#include <rpc.hpp>

Inheritance diagram for saga::rpc::rpc:

List of all members.

Public Member Functions

 rpc (session const &s, saga::url name=saga::url())
 Initializes a remote function handle.
 rpc (saga::url name)
 Brief description starts here.
 rpc (void)
 Brief description starts here.
 ~rpc (void)
 Destroys the object.
void call (std::vector< parameter > parameters)
 Call the remote procedure.
void close (double timeout=0.0)
 Closes the rpc handle instance.

Static Public Member Functions

static rpc create (session const &s, saga::url name=saga::url())
 Factory function resembling rpc(session, url) constructor.
static rpc create (saga::url name=saga::url())
 Factory function resembling rpc(url) constructor.
template<typename Tag >
static saga::task create (saga::url name=saga::url())

Protected Member Functions

TR1::shared_ptr< saga::impl::rpc > get_impl_sp (void) const
 @ /** These methods are not within API scope */
saga::impl::rpc * get_impl (void) const
 rpc (saga::impl::rpc *impl)

Detailed Description

This class represents a remote function handle, which can be called (repeatedly), and returns the result of the respective remote procedure invocation.


Constructor & Destructor Documentation

saga::rpc::rpc::rpc ( saga::impl::rpc *  impl) [explicit, protected]
saga::rpc::rpc::rpc ( session const &  s,
saga::url  name = saga::url() 
) [explicit]

Initializes a remote function handle.

Returns:
The newly created object.

References get_impl().

saga::rpc::rpc::rpc ( saga::url  name) [explicit]

Brief description starts here.

References get_impl().

saga::rpc::rpc::rpc ( void  )

Brief description starts here.

saga::rpc::rpc::~rpc ( void  )

Destroys the object.


Member Function Documentation

TR1::shared_ptr< saga::impl::rpc > saga::rpc::rpc::get_impl_sp ( void  ) const [protected]

@ /** These methods are not within API scope */

Reimplemented from saga::object.

saga::impl::rpc * saga::rpc::rpc::get_impl ( void  ) const [protected]

Reimplemented from saga::object.

Referenced by rpc().

static rpc saga::rpc::rpc::create ( session const &  s,
saga::url  name = saga::url() 
) [inline, static]

Factory function resembling rpc(session, url) constructor.

static rpc saga::rpc::rpc::create ( saga::url  name = saga::url()) [inline, static]

Factory function resembling rpc(url) constructor.

@ SAGA_CALL_CREATE_2_DEF_1(session const&, saga::url, saga::url())

template<typename Tag >
static saga::task saga::rpc::rpc::create ( saga::url  name = saga::url()) [inline, static]
void saga::rpc::rpc::call ( std::vector< parameter parameters) [inline]

Call the remote procedure.

void saga::rpc::rpc::close ( double  timeout = 0.0) [inline]

Closes the rpc handle instance.

@ SAGA_CALL_PUB_1_DEF_0(call, std::vector<parameter>&)


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines