HandlerState.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/Types.h"

#include <string>

namespace OnixS { namespace CME { namespace DropCopy {

/// Available Handler's states.
struct ONIXS_CME_DROP_COPY_EXPORT HandlerStates
{
    /// Available Handler's states.
    enum Enum
    {
        /// Handler is stopped.
        Stopped = 0,

        /// Handler is started but no data processing is performed yet.
        Started,
    };

    /// Returns string representation of a state.
    static std::string toString(Enum state);
};

/// States of the Handler in which it may reside.
typedef HandlerStates::Enum HandlerState;

}}}