Handler.h

Go to the documentation of this file.

/*
 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
 *
 * This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
 * and international copyright treaties.
 *
 * Access to and use of the software is governed by the terms of the applicable OnixS Software
 * Services Agreement (the Agreement) and Customer end user license agreements granting
 * a non-assignable, non-transferable and non-exclusive license to use the software
 * for it's own data processing purposes under the terms defined in the Agreement.
 *
 * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any
 * part of this source code or associated reference material to any other location for further
 * reproduction or redistribution, and any amendments to this copyright notice, are expressly
 * prohibited.
 *
 * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
 * the terms of the Agreement is a violation of copyright law.
 */

#pragma once

#include "OnixS/CME/DropCopy/DropCopyServiceListener.h"
#include "OnixS/CME/DropCopy/ErrorListener.h"
#include "OnixS/CME/DropCopy/Export.h"
#include "OnixS/CME/DropCopy/HandlerSettings.h"
#include "OnixS/CME/DropCopy/HandlerStateChangeListener.h"
#include "OnixS/CME/DropCopy/Types.h"
#include "OnixS/CME/DropCopy/WarningListener.h"

namespace OnixS { namespace CME { namespace DropCopy {

/// CME Drop Copy Handler.
class ONIXS_CME_DROP_COPY_EXPORT Handler
{
public:
    /// Initialize instance.
    ///
    /// \param settings Handler settings.
    Handler(const HandlerSettings& settings);

    /// Finalize instance.
    ~Handler();

    /// Log a debug message.
    ///
    /// \param message Message.
    void logDebug(const std::string& message);

    /// Log an error message.
    ///
    /// \param message Message.
    void logError(const std::string& message);

    /// Log an information message.
    ///
    /// \param message Message.
    void logMessage(const std::string& message);

    /// Log a warning message.
    ///
    /// \param message Message.
    void logWarning(const std::string& message);

    /// Register the error listener.
    ///
    /// \param listener Error listener.
    void registerErrorListener(ErrorListener* listener);

    /// Register the warning listener.
    ///
    /// \param listener Warning listener.
    void registerWarningListener(WarningListener* listener);

    /// Register the Handler state change listener.
    ///
    /// \param listener Handler state change listener.
    void registerHandlerStateChangeListener(HandlerStateChangeListener* listener);

    /// Register the Handler state change listener.
    ///
    /// \param listener DropCopy service listener.
    void registerDropCopyServiceListener(DropCopyServiceListener* listener);

    /// Logon to CME DropCopy session.
    ///
    /// \param host CME Session host.
    /// \param port CME Session port.
    /// \param accessKeyId CME access key ID.
    /// \param secretKey CME secret key.
    void logon(
        const std::string& host,
        int port,
        const std::string& accessKeyId,
        const std::string& secretKey
    );

    /// Logout from CME drop copy session.
    void logout();

    /// Reset session sequence numbers and stored application feed IDs.
    void reset();

    /**
     * Gets an expected sequence number of the next incoming message.
     *
     * \returns The expected sequence number of the next incoming message.
     */
    int inSeqNum() const;

    /**
     * Sets an expected sequence number of the next incoming message.
     *
     * \param seqNum The expected sequence number of the next incoming message.
     */
    void inSeqNum(int seqNum);

    /**
     * Gets a sequence number of the next outgoing message.
     *
     * \returns The sequence number of the next outgoing message.
     */
    int outSeqNum() const;

    /**
     * Sets a sequence number of the next outgoing message.
     *
     * \param seqNum The sequence number of the next outgoing message.
     */
    void outSeqNum(int seqNum);

    /// Returns Handler's version.
    static const std::string& version();

private:
    Handler(const Handler&);            // no implementation
    Handler& operator=(const Handler&); // no implementation

private:
    struct Impl;
    Impl* impl_;
};

}}}