HandlerStateChangeListener.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/Export.h"
#include "OnixS/CME/DropCopy/HandlerState.h"

namespace OnixS { namespace CME { namespace DropCopy {

/// Handler state change.
class ONIXS_CME_DROP_COPY_EXPORT HandlerStateChange
{
public:
    HandlerStateChange(HandlerState newState, HandlerState oldState);

    /// New State.
    HandlerState newState() const;

    /// Old state.
    HandlerState oldState() const;

    /// String representation.
    std::string toString() const;

private:
    HandlerState newState_;
    HandlerState oldState_;

    HandlerStateChange(const HandlerStateChange& other);
    HandlerStateChange& operator=(const HandlerStateChange& other);
};

inline HandlerState HandlerStateChange::newState() const
{
    return newState_;
}

inline HandlerState HandlerStateChange::oldState() const
{
    return oldState_;
}

/// Handler state change listener.
class ONIXS_CME_DROP_COPY_EXPORT HandlerStateChangeListener
{
public:
    /// Is called when the handler state is changed.
    virtual void onHandlerStateChange(const HandlerStateChange& change) = 0;

protected:
    virtual ~HandlerStateChangeListener();
};

}}}

namespace std {
// Outputs message into standard stream.
ONIXS_CME_DROP_COPY_EXPORT std::ostream&
operator<<(std::ostream&, const OnixS::CME::DropCopy::HandlerStateChange&);
}