BLPAPI C++
3.24.11
|
#include <blpapi_request.h>
Public Member Functions | |
Request (blpapi_Request_t *handle) | |
Request (RequestRef src) | |
Request (Request &src) | |
~Request () | |
operator RequestRef () | |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, bool value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, char value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, Int32 value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, Int64 value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, Float32 value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, Float64 value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, const Datetime &value) |
BLPAPI_DEPRECATE_STRING_NAME void | set (const char *name, const char *value) |
void | set (const Name &name, bool value) |
void | set (const Name &name, char value) |
void | set (const Name &name, Int32 value) |
void | set (const Name &name, Int64 value) |
void | set (const Name &name, Float32 value) |
void | set (const Name &name, Float64 value) |
void | set (const Name &name, const Datetime &value) |
void | set (const Name &name, const char *value) |
void | set (const Name &name, const std::string &value) |
void | set (const Name &name, const void *value, std::size_t length) |
template<typename BYTES , typename std::enable_if< IsByteSequence< BYTES >::value, bool >::type = true> | |
void | set (const Name &name, const BYTES &value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, bool value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, char value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, Int32 value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, Int64 value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, Float32 value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, Float64 value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, const Datetime &value) |
BLPAPI_DEPRECATE_STRING_NAME void | append (const char *name, const char *value) |
void | append (const Name &name, bool value) |
void | append (const Name &name, char value) |
void | append (const Name &name, Int32 value) |
void | append (const Name &name, Int64 value) |
void | append (const Name &name, Float32 value) |
void | append (const Name &name, Float64 value) |
void | append (const Name &name, const Datetime &value) |
void | append (const Name &name, const char *value) |
void | append (const Name &name, const std::string &value) |
Element | asElement () |
BLPAPI_DEPRECATE_STRING_NAME Element | getElement (const char *name) |
Element | getElement (const Name &name) |
BLPAPI_DEPRECATE_STRING_NAME const Element | getElement (const char *name) const |
const Element | getElement (const Name &name) const |
const Element | asElement () const |
const char * | getRequestId () const |
blpapi_Request_t * | handle () const |
std::ostream & | print (std::ostream &stream, int level=0, int spacesPerLevel=4) const |
A single request to a single service.
Request objects are created using Service::createRequest() or Service::createAuthorizationRequest(). They are used with Session::sendRequest() or Session::sendAuthorizationRequest().
The Request object contains the parameters for a single request to a single service. Once a Request has been created its fields can be populated directly using the convenience functions set() and append() functions or using the Element interface on the Element returned by asElement().
The schema for the Request can be queried using the Element interface on the Element returned by asElement().
Request objects cannot be duplicated. Copying a Request causes the original Request to become invalid. The API provides support for common idioms which require a normal copy constructor. For example, you can write the following code.
However, if you write this requestOne
will become invalid and unusable.
This should be written as follows.
|
explicit |
Request | ( | RequestRef | src | ) |
~Request | ( | ) |
Destructor.
void append | ( | const char * | name, |
bool | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
char | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
Int32 | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
Int64 | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
Float32 | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
Float64 | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
const Datetime & | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const char * | name, |
const char * | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const Name & | name, |
bool | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const Name & | name, |
char | value | ||
) |
Equivalent to asElement().append(name, value).
Equivalent to asElement().append(name, value).
Equivalent to asElement().append(name, value).
Equivalent to asElement().append(name, value).
Equivalent to asElement().append(name, value).
Equivalent to asElement().append(name, value).
void append | ( | const Name & | name, |
const char * | value | ||
) |
Equivalent to asElement().append(name, value).
void append | ( | const Name & | name, |
const std::string & | value | ||
) |
Equivalent to asElement().append(name, value).
Element getElement | ( | const char * | name | ) |
Equivalent to asElement().getElement(name).
Equivalent to asElement().getElement(name).
const Element getElement | ( | const char * | name | ) | const |
Equivalent to asElement().getElement(name).
Equivalent to asElement().getElement(name).
const char * getRequestId | ( | ) | const |
Return a pointer offering unmodifiable access to the request's id if one exists, otherwise return null.
If there are issues with this request, the request id can be reported to Bloomberg for troubleshooting purposes.
Note that request id is not the same as correlation id and should not be used for correlation purposes.
blpapi_Request_t * handle | ( | ) | const |
operator RequestRef | ( | ) |
std::ostream & print | ( | std::ostream & | stream, |
int | level = 0 , |
||
int | spacesPerLevel = 4 |
||
) | const |
Format this Request to the specified output stream
at the (absolute value of) the optionally specified indentation level
and return a reference to stream
. If level
is specified, optionally specify spacesPerLevel
, the number of spaces per indentation level for this and all of its nested objects. If level
is negative, suppress indentation of the first line. If spacesPerLevel
is negative, format the entire output on one line, suppressing all but the initial indentation (as governed by level
).
void set | ( | const char * | name, |
bool | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
char | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
Int32 | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
Int64 | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
Float32 | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
Float64 | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
const Datetime & | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const char * | name, |
const char * | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const Name & | name, |
bool | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const Name & | name, |
char | value | ||
) |
Equivalent to asElement().set(name, value).
Equivalent to asElement().set(name, value).
Equivalent to asElement().set(name, value).
Equivalent to asElement().set(name, value).
Equivalent to asElement().set(name, value).
Equivalent to asElement().set(name, value).
void set | ( | const Name & | name, |
const char * | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const Name & | name, |
const std::string & | value | ||
) |
Equivalent to asElement().set(name, value).
void set | ( | const Name & | name, |
const void * | value, | ||
std::size_t | length | ||
) |
Equivalent to asElement().set(name, value, length).
void set | ( | const Name & | name, |
const BYTES & | value | ||
) |
Equivalent to asElement().set(name, value).