blpapi_service.h

Go to the documentation of this file.

/* Copyright 2012. Bloomberg Finance L.P.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:  The above
 * copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

 
#ifndef INCLUDED_BLPAPI_SERVICE
#define INCLUDED_BLPAPI_SERVICE

 
#ifndef INCLUDED_BLPAPI_DEFS
#include <blpapi_defs.h>
#endif
 
#ifndef INCLUDED_BLPAPI_TYPES
#include <blpapi_types.h>
#endif
 
#ifndef INCLUDED_BLPAPI_SCHEMA
#include <blpapi_schema.h>
#endif
 
#ifndef INCLUDED_BLPAPI_REQUEST
#include <blpapi_request.h>
#endif
 
#ifndef INCLUDED_BLPAPI_CORRELATIONID
#include <blpapi_correlationid.h>
#endif
 
#ifndef INCLUDED_BLPAPI_STREAMPROXY
#include <blpapi_streamproxy.h>
#endif
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif



BLPAPI_EXPORT
const char *blpapi_Operation_name(blpapi_Operation_t *operation);

BLPAPI_EXPORT
const char *blpapi_Operation_description(blpapi_Operation_t *operation);

BLPAPI_EXPORT
int blpapi_Operation_requestDefinition(blpapi_Operation_t *operation,
        blpapi_SchemaElementDefinition_t **requestDefinition);

BLPAPI_EXPORT
int blpapi_Operation_numResponseDefinitions(blpapi_Operation_t *operation);

BLPAPI_EXPORT
int blpapi_Operation_responseDefinition(blpapi_Operation_t *operation,
        blpapi_SchemaElementDefinition_t **responseDefinition,
        size_t index);

BLPAPI_EXPORT
int blpapi_Operation_responseDefinitionFromName(blpapi_Operation_t *operation,
        blpapi_SchemaElementDefinition_t **responseDefinition,
        const blpapi_Name_t *name);

BLPAPI_EXPORT
const char *blpapi_Service_name(blpapi_Service_t *service);

BLPAPI_EXPORT
const char *blpapi_Service_description(blpapi_Service_t *service);

BLPAPI_EXPORT
int blpapi_Service_numOperations(blpapi_Service_t *service);

BLPAPI_EXPORT
int blpapi_Service_numEventDefinitions(blpapi_Service_t *service);

BLPAPI_EXPORT
int blpapi_Service_addRef(blpapi_Service_t *service);

BLPAPI_EXPORT
void blpapi_Service_release(blpapi_Service_t *service);

BLPAPI_EXPORT
const char *blpapi_Service_authorizationServiceName(blpapi_Service_t *service);

BLPAPI_EXPORT
int blpapi_Service_getOperation(blpapi_Service_t *service,
        blpapi_Operation_t **operation,
        const char *nameString,
        const blpapi_Name_t *name);

BLPAPI_EXPORT
int blpapi_Service_getOperationAt(blpapi_Service_t *service,
        blpapi_Operation_t **operation,
        size_t index);

BLPAPI_EXPORT
int blpapi_Service_getEventDefinition(blpapi_Service_t *service,
        blpapi_SchemaElementDefinition_t **result,
        const char *nameString,
        const blpapi_Name_t *name);

BLPAPI_EXPORT
int blpapi_Service_getEventDefinitionAt(blpapi_Service_t *service,
        blpapi_SchemaElementDefinition_t **result,
        size_t index);

BLPAPI_EXPORT
int blpapi_Service_createRequest(blpapi_Service_t *service,
        blpapi_Request_t **request,
        const char *operation);

BLPAPI_EXPORT
int blpapi_Service_createAuthorizationRequest(blpapi_Service_t *service,
        blpapi_Request_t **request,
        const char *operation);

BLPAPI_EXPORT
int blpapi_Service_createPublishEvent(
        blpapi_Service_t *service, blpapi_Event_t **event);

BLPAPI_EXPORT
int blpapi_Service_createAdminEvent(
        blpapi_Service_t *service, blpapi_Event_t **event);

BLPAPI_EXPORT
int blpapi_Service_createResponseEvent(blpapi_Service_t *service,
        const blpapi_CorrelationId_t *correlationId,
        blpapi_Event_t **event);

BLPAPI_EXPORT int blpapi_Service_print(const blpapi_Service_t *service,
        blpapi_StreamWriter_t streamWriter,
        void *stream,
        int level,
        int spacesPerLevel);

 
#ifdef __cplusplus
}
 
#ifndef INCLUDED_BLPAPI_EXCEPTION
#include <blpapi_exception.h>
#endif
 
#include <utility>
 
namespace BloombergLP {
namespace blpapi {

class Operation {
 
    blpapi_Operation_t *d_handle;
 
  public:
    explicit Operation(blpapi_Operation_t *handle);
 
    ~Operation();
 
    const char *name() const;
 
    const char *description() const;
 
    SchemaElementDefinition requestDefinition() const;
 
    int numResponseDefinitions() const;
 
    SchemaElementDefinition responseDefinition(size_t index) const;
 
    SchemaElementDefinition responseDefinition(const Name& name) const;

    blpapi_Operation_t *handle() const;
 
    bool isValid() const;
};

class Service {
 
    blpapi_Service_t *d_handle;
 
    void addRef();
    void release();
 
  public:
    // PUBLIC TYPES
    struct TestService { }; // tag type
 
    // CREATORS
    Service();
 
    explicit Service(blpapi_Service_t *handle);
 
    Service(blpapi_Service_t *handle, TestService tag);
 
    Service(const Service& original);
 
    ~Service();
 
    // MANIPULATORS
 
    Service& operator=(const Service& rhs);
 
    // ACCESSORS
 
    Request createRequest(const char *operation) const;
 
    Request createAuthorizationRequest(
            const char *authorizationOperation = 0) const;
 
    blpapi_Event_t *createPublishEvent() const;
 
    blpapi_Event_t *createAdminEvent() const;
 
    blpapi_Event_t *createResponseEvent(
            const CorrelationId& correlationId) const;
 
    const char *name() const;
 
    const char *description() const;
 
    size_t numOperations() const;
 
    bool hasOperation(const char *name) const;
 
    bool hasOperation(const Name& name) const;
 
    Operation getOperation(size_t index) const;
 
    Operation getOperation(const char *name) const;
 
    Operation getOperation(const Name& name) const;
 
    int numEventDefinitions() const;
 
    bool hasEventDefinition(const char *name) const;
 
    bool hasEventDefinition(const Name& name) const;
 
    SchemaElementDefinition getEventDefinition(size_t index) const;
 
    SchemaElementDefinition getEventDefinition(const char *name) const;
 
    SchemaElementDefinition getEventDefinition(const Name& name) const;
 
    const char *authorizationServiceName() const;
 
    bool isValid() const;

    blpapi_Service_t *handle() const;
 
    std::ostream& print(
            std::ostream& stream, int level = 0, int spacesPerLevel = 4) const;
};

 
// FREE OPERATORS
std::ostream& operator<<(std::ostream& stream, const Service& service);
 
// ============================================================================
//                      INLINE FUNCTION DEFINITIONS
// ============================================================================
 
// ---------------
// class Operation
// ---------------
inline Operation::Operation(blpapi_Operation_t *newHandle)
    : d_handle(newHandle)
{
}
 
inline Operation::~Operation() { }
 
inline const char *Operation::name() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Operation_name(d_handle);
}
 
inline const char *Operation::description() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Operation_description(d_handle);
}
 
inline SchemaElementDefinition Operation::requestDefinition() const
{
    blpapi_SchemaElementDefinition_t *definition = 0;
 
    ExceptionUtil::throwOnError(
            blpapi_Operation_requestDefinition(d_handle, &definition));
    return SchemaElementDefinition(definition);
}
 
inline int Operation::numResponseDefinitions() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Operation_numResponseDefinitions(d_handle);
}
 
inline SchemaElementDefinition Operation::responseDefinition(
        size_t index) const
{
    blpapi_SchemaElementDefinition_t *definition = 0;
 
    ExceptionUtil::throwOnError(
            blpapi_Operation_responseDefinition(d_handle, &definition, index));
    return SchemaElementDefinition(definition);
}
 
inline SchemaElementDefinition Operation::responseDefinition(
        const Name& name) const
{
    blpapi_SchemaElementDefinition_t *definition = 0;
 
    ExceptionUtil::throwOnError(
            BLPAPI_CALL(blpapi_Operation_responseDefinitionFromName)(
                    d_handle, &definition, name.impl()));
    return SchemaElementDefinition(definition);
}

inline blpapi_Operation_t *Operation::handle() const { return d_handle; }
 
inline bool Operation::isValid() const { return d_handle != 0; }
// -------------
// class Service
// -------------
 
inline Service::Service()
    : d_handle(0)
{
}
 
inline Service::Service(const Service& original)
    : d_handle(original.d_handle)
{
    addRef();
}
 
inline Service::Service(blpapi_Service_t *newHandle)
    : d_handle(newHandle)
{
    addRef();
}
 
inline Service::Service(blpapi_Service_t *handle, TestService)
    : d_handle(handle)
{
    // test service de-serialise releases the handle to us
}
 
inline Service::~Service() { release(); }
 
inline Service& Service::operator=(const Service& rhs)
{
    using std::swap;
 
    Service tmp(rhs);
    swap(tmp.d_handle, d_handle);
 
    return *this;
}
 
inline void Service::addRef()
{
    if (d_handle) {
        blpapi_Service_addRef(d_handle);
    }
}
 
inline void Service::release()
{
    if (d_handle) {
        blpapi_Service_release(d_handle);
    }
}
 
inline Request Service::createRequest(const char *operation) const
{
    blpapi_Request_t *request = 0;
    ExceptionUtil::throwOnError(
            blpapi_Service_createRequest(d_handle, &request, operation));
    return Request(request);
}
 
inline Request Service::createAuthorizationRequest(
        const char *authorizationOperation) const
{
    blpapi_Request_t *request = 0;
    ExceptionUtil::throwOnError(blpapi_Service_createAuthorizationRequest(
            d_handle, &request, authorizationOperation));
    return Request(request);
}
 
inline blpapi_Event_t *Service::createPublishEvent() const
{
    blpapi_Event_t *event = 0;
    ExceptionUtil::throwOnError(
            blpapi_Service_createPublishEvent(d_handle, &event));
    return event;
}
 
inline blpapi_Event_t *Service::createAdminEvent() const
{
    blpapi_Event_t *event = 0;
    ExceptionUtil::throwOnError(
            blpapi_Service_createAdminEvent(d_handle, &event));
    return event;
}
 
inline blpapi_Event_t *Service::createResponseEvent(
        const CorrelationId& correlationId) const
{
    blpapi_Event_t *event = 0;
    ExceptionUtil::throwOnError(blpapi_Service_createResponseEvent(
            d_handle, &correlationId.impl(), &event));
    return event;
}

inline blpapi_Service_t *Service::handle() const { return d_handle; }
 
inline bool Service::isValid() const { return (d_handle != 0); }
 
inline const char *Service::name() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Service_name(d_handle);
}
 
inline const char *Service::description() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Service_description(d_handle);
}
 
inline size_t Service::numOperations() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return static_cast<size_t>(blpapi_Service_numOperations(d_handle));
}
 
inline bool Service::hasOperation(const char *operationName) const
{
    blpapi_Operation_t *operation = 0;
    return blpapi_Service_getOperation(d_handle, &operation, operationName, 0)
            == 0;
}
 
inline bool Service::hasOperation(const Name& operationName) const
{
    blpapi_Operation_t *operation = 0;
    return blpapi_Service_getOperation(
                   d_handle, &operation, 0, operationName.impl())
            == 0;
}
 
inline Operation Service::getOperation(size_t index) const
{
    blpapi_Operation_t *operation = 0;
    ExceptionUtil::throwOnError(
            blpapi_Service_getOperationAt(d_handle, &operation, index));
    return Operation(operation);
}
 
inline Operation Service::getOperation(const char *operationName) const
{
    blpapi_Operation_t *operation = 0;
    ExceptionUtil::throwOnError(blpapi_Service_getOperation(
            d_handle, &operation, operationName, 0));
    return Operation(operation);
}
 
inline Operation Service::getOperation(const Name& operationName) const
{
    blpapi_Operation_t *operation = 0;
    ExceptionUtil::throwOnError(blpapi_Service_getOperation(
            d_handle, &operation, 0, operationName.impl()));
    return Operation(operation);
}
 
inline int Service::numEventDefinitions() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Service_numEventDefinitions(d_handle);
}
 
inline bool Service::hasEventDefinition(const char *definitionName) const
{
    blpapi_SchemaElementDefinition_t *eventDefinition = 0;
 
    return blpapi_Service_getEventDefinition(
                   d_handle, &eventDefinition, definitionName, 0)
                    == 0
            ? true
            : false;
}
 
inline bool Service::hasEventDefinition(const Name& definitionName) const
{
    blpapi_SchemaElementDefinition_t *eventDefinition = 0;
 
    return blpapi_Service_getEventDefinition(
                   d_handle, &eventDefinition, 0, definitionName.impl())
                    == 0
            ? true
            : false;
}
 
inline SchemaElementDefinition Service::getEventDefinition(size_t index) const
{
    blpapi_SchemaElementDefinition_t *eventDefinition = 0;
 
    ExceptionUtil::throwOnError(blpapi_Service_getEventDefinitionAt(
            d_handle, &eventDefinition, index));
    return SchemaElementDefinition(eventDefinition);
}
 
inline SchemaElementDefinition Service::getEventDefinition(
        const char *definitionName) const
{
    blpapi_SchemaElementDefinition_t *eventDefinition = 0;
    ExceptionUtil::throwOnError(blpapi_Service_getEventDefinition(
            d_handle, &eventDefinition, definitionName, 0));
    return SchemaElementDefinition(eventDefinition);
}
 
inline SchemaElementDefinition Service::getEventDefinition(
        const Name& definitionName) const
{
    blpapi_SchemaElementDefinition_t *eventDefinition = 0;
    ExceptionUtil::throwOnError(blpapi_Service_getEventDefinition(
            d_handle, &eventDefinition, 0, definitionName.impl()));
    return SchemaElementDefinition(eventDefinition);
}
 
inline const char *Service::authorizationServiceName() const
{
    if (!isValid()) {
        ExceptionUtil::throwOnError(BLPAPI_ERROR_ILLEGAL_ARG);
    }
 
    return blpapi_Service_authorizationServiceName(d_handle);
}
 
inline std::ostream& Service::print(
        std::ostream& stream, int level, int spacesPerLevel) const
{
    blpapi_Service_print(d_handle,
            StreamProxyOstream::writeToStream,
            &stream,
            level,
            spacesPerLevel);
    return stream;
}
 
inline std::ostream& operator<<(std::ostream& stream, const Service& service)
{
    return service.print(stream, 0, -1);
}
 
} // close namespace blpapi
} // close namespace BloombergLP
 
#endif // #ifdef __cplusplus
#endif // #ifndef INCLUDED_BLPAPI_SERVICE