blpapi::RequestTemplate Class Reference

#include <blpapi_requesttemplate.h>

List of all members.

Public Member Functions
	RequestTemplate (blpapi_RequestTemplate_t *handle=0)
	RequestTemplate (const RequestTemplate &original)
	~RequestTemplate ()
RequestTemplate &	operator= (const RequestTemplate &rhs)
const blpapi_RequestTemplate_t *	impl () const
blpapi_RequestTemplate_t *	impl ()

---

Detailed Description

A handle to a single request template.

The RequestTemplate is a handle to a single underlying request template. The underlying request template is reference counted and destroyed when the last RequestTemplate object which references it is destroyed. RequestTemplate objects are copyable, there is no difference which instance of a RequestTemplate is used for sending requests. A copy of an RequestTemplate contains a reference to the same underlying request template as an original object.

Request templates may accelerate request processing by caching information required for a response (as it is done by the snapshot service) and eliminating the need to create a new request object every time.

Request templates are obtained from a Session and should be always used with the session that creates the template. When a session is terminated, any request templates associated with that session become invalid. Results of sending or canceling of invalid requests templates is undefined.

In order to send a request represented by a template, the "Session::sendRequest" method should be called with the RequestTemplate object passed as the first argument.

---

Constructor & Destructor Documentation

blpapi::RequestTemplate::RequestTemplate

(

blpapi_RequestTemplate_t *

handle = 0

)

Construct a request template handle for the underlying request template specified by optionally specified handle.

blpapi::RequestTemplate::RequestTemplate

(

const RequestTemplate &

original

)

Construct a request template handle using underlying request template from original. This will add a reference to the underlying request template.

blpapi::RequestTemplate::~RequestTemplate

(

)

Destroy this request template handle. This will also destroy the underlying request template if there no other references to it.

---

Member Function Documentation

RequestTemplate& blpapi::RequestTemplate::operator=

(

const RequestTemplate &

rhs

)

Copies the request template handle specified by rhs into the current request template handle. It will increase reference count of the underlying request template of the rhs and decrease reference count (and possibly destroy) of the underlying request template previously referenced by this object.

const blpapi_RequestTemplate_t* blpapi::RequestTemplate::impl

(

)

const

Returns the internal implementation.

blpapi_RequestTemplate_t* blpapi::RequestTemplate::impl

(

)

Returns the internal implementation.

---

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

• blpapi_requesttemplate.h