blpapi_tlsoptions.h

Go to the documentation of this file.

/* Copyright 2016. 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_TLSOPTIONS
#define INCLUDED_BLPAPI_TLSOPTIONS

#ifndef INCLUDED_BLPAPI_CALL
#include <blpapi_call.h>
#endif

#ifndef INCLUDED_BLPAPI_DEFS
#include <blpapi_defs.h>
#endif

#ifndef INCLUDED_BLPAPI_EXCEPTION
#include <blpapi_exception.h>
#endif

#ifndef INCLUDED_BLPAPI_TYPES
#include <blpapi_types.h>
#endif

#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

BLPAPI_EXPORT
blpapi_TlsOptions_t *blpapi_TlsOptions_create(void);

BLPAPI_EXPORT
blpapi_TlsOptions_t *blpapi_TlsOptions_duplicate(
        const blpapi_TlsOptions_t *parameters);

BLPAPI_EXPORT
void blpapi_TlsOptions_copy(
        blpapi_TlsOptions_t *lhs, const blpapi_TlsOptions_t *rhs);

BLPAPI_EXPORT
void blpapi_TlsOptions_destroy(blpapi_TlsOptions_t *parameters);

BLPAPI_EXPORT
blpapi_TlsOptions_t *blpapi_TlsOptions_createFromFiles(
        const char *clientCredentialsFileName,
        const char *clientCredentialsPassword,
        const char *trustedCertificatesFileName);

BLPAPI_EXPORT
blpapi_TlsOptions_t *blpapi_TlsOptions_createFromBlobs(
        const char *clientCredentialsRawData,
        int clientCredentialsRawDataLength,
        const char *clientCredentialsPassword,
        const char *trustedCertificatesRawData,
        int trustedCertificatesRawDataLength);

BLPAPI_EXPORT
void blpapi_TlsOptions_setTlsHandshakeTimeoutMs(
        blpapi_TlsOptions_t *paramaters, int tlsHandshakeTimeoutMs);

BLPAPI_EXPORT
void blpapi_TlsOptions_setCrlFetchTimeoutMs(
        blpapi_TlsOptions_t *paramaters, int crlFetchTimeoutMs);

#ifdef __cplusplus
}

#include <cassert>

namespace BloombergLP {
namespace blpapi {

// ================
// class TlsOptions
// ================

class TlsOptions {

  private:
    blpapi_TlsOptions_t *d_handle_p;

    explicit TlsOptions(blpapi_TlsOptions_t *handle);
  public:
    TlsOptions();
    TlsOptions(const TlsOptions&);
    ~TlsOptions();
    // MANIPULATORS

    TlsOptions& operator=(const TlsOptions& rhs);
    static TlsOptions createFromFiles(const char *clientCredentialsFileName,
            const char *clientCredentialsPassword,
            const char *trustedCertificatesFileName);
    static TlsOptions createFromBlobs(const char *clientCredentialsRawData,
            int clientCredentialsRawDataLength,
            const char *clientCredentialsPassword,
            const char *trustedCertificatesRawData,
            int trustedCertificatesRawDataLength);
    void setTlsHandshakeTimeoutMs(int tlsHandshakeTimeoutMs);
    void setCrlFetchTimeoutMs(int crlFetchTimeoutMs);
    // ACCESSORS

    blpapi_TlsOptions_t *handle() const;
};

// ============================================================================
//                      INLINE FUNCTION DEFINITIONS
// ============================================================================

// ----------------
// class TlsOptions
// ----------------
inline TlsOptions::TlsOptions(blpapi_TlsOptions_t *handle)
    : d_handle_p(handle)
{
    assert(d_handle_p);
}

inline TlsOptions::TlsOptions()
{
    d_handle_p = BLPAPI_CALL(blpapi_TlsOptions_create)();
}

inline TlsOptions::TlsOptions(const TlsOptions& options)
{
    d_handle_p = BLPAPI_CALL(blpapi_TlsOptions_duplicate)(options.handle());
}

inline TlsOptions::~TlsOptions()
{
    BLPAPI_CALL_UNCHECKED(blpapi_TlsOptions_destroy)(d_handle_p);
}

inline TlsOptions& TlsOptions::operator=(const TlsOptions& rhs)
{
    BLPAPI_CALL(blpapi_TlsOptions_copy)(this->handle(), rhs.handle());
    return *this;
}

inline TlsOptions TlsOptions::createFromFiles(
        const char *clientCredentialsFileName,
        const char *clientCredentialsPassword,
        const char *trustedCertificatesFileName)
{
    blpapi_TlsOptions_t *handle = BLPAPI_CALL(
            blpapi_TlsOptions_createFromFiles)(clientCredentialsFileName,
            clientCredentialsPassword,
            trustedCertificatesFileName);
    return TlsOptions(handle);
}

inline TlsOptions TlsOptions::createFromBlobs(
        const char *clientCredentialsRawData,
        int clientCredentialsRawDataLength,
        const char *clientCredentialsPassword,
        const char *trustedCertificatesRawData,
        int trustedCertificatesRawDataLength)
{
    blpapi_TlsOptions_t *handle = BLPAPI_CALL(
            blpapi_TlsOptions_createFromBlobs)(clientCredentialsRawData,
            clientCredentialsRawDataLength,
            clientCredentialsPassword,
            trustedCertificatesRawData,
            trustedCertificatesRawDataLength);
    return TlsOptions(handle);
}

inline void TlsOptions::setTlsHandshakeTimeoutMs(int tlsHandshakeTimeoutMs)
{
    BLPAPI_CALL(blpapi_TlsOptions_setTlsHandshakeTimeoutMs)
    (d_handle_p, tlsHandshakeTimeoutMs);
}

inline void TlsOptions::setCrlFetchTimeoutMs(int crlFetchTimeoutMs)
{
    BLPAPI_CALL(blpapi_TlsOptions_setCrlFetchTimeoutMs)
    (d_handle_p, crlFetchTimeoutMs);
}

inline blpapi_TlsOptions_t *TlsOptions::handle() const { return d_handle_p; }

} // close namespace blpapi
} // close namespace BloombergLP

#endif // #ifdef __cplusplus
#endif // #ifndef INCLUDED_BLPAPI_TLSOPTIONS