HandlerState.h

Go to the documentation of this file.

/*
 * Copyright (c) Onix Solutions Limited. All rights reserved.
 *
 * This software owned by Onix Solutions Limited 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 "Export.h"

namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {

/// Available Handler's states.
struct ONIXS_ICEMDH_EXPORT HandlerStates
{
    /// \copydoc HandlerStates
    enum Enum
    {
        /// The Handler is stopped.
        Stopped = 0,

        /// The Handler is stopping.
        Stopping,

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

        /// Download of security definition messages is started.
        SecurityDefinitionsRecoveryStarted,

        /// Download of security definition messages is finished.
        SecurityDefinitionsRecoveryFinished,

        /// The correct books state is lost.
        ///
        /// Handler switches to this state when it joins the market and the
        /// initial books state is built from multicast messages or when the
        /// message sequence number gap is detected, so the book state should
        /// be re-built from multicast messages again.
        ///
        /// It should be assumed at this point that all books maintained
        /// in the Handler may no longer have the correct, latest state
        /// maintained by ICE, so they are cleared.
        BooksResynchronizationStarted,

        /// The latest books state is restored.
        ///
        /// Handler switches to this state when the the latest books state
        /// is restored (all snapshot data is retrieved).
        ///
        /// It should be assumed at this point that all books maintained in
        /// the Handler have the correct, latest state maintained by ICE.
        BooksResynchronizationFinished,
    };

    /// Returns string representation.
    static const char* toString(Enum state);
};

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

}}}}                                                        // namespace MarketData, iMpact, ICE, OnixS