OnixS ICE iMpact Multicast Price Feed Handler C++ library  8.6.0
API documentation
HandlerState.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) Onix Solutions Limited. All rights reserved.
3  *
4  * This software owned by Onix Solutions Limited and is protected by copyright law
5  * and international copyright treaties.
6  *
7  * Access to and use of the software is governed by the terms of the applicable ONIXS Software
8  * Services Agreement (the Agreement) and Customer end user license agreements granting
9  * a non-assignable, non-transferable and non-exclusive license to use the software
10  * for it's own data processing purposes under the terms defined in the Agreement.
11  *
12  * Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
13  * of this source code or associated reference material to any other location for further reproduction
14  * or redistribution, and any amendments to this copyright notice, are expressly prohibited.
15  *
16  * Any reproduction or redistribution for sale or hiring of the Software not in accordance with
17  * the terms of the Agreement is a violation of copyright law.
18  */
19 
20 #pragma once
21 
22 #include "Export.h"
23 
24 namespace OnixS { namespace ICE { namespace iMpact { namespace MarketData {
25 
26 /// Available Handler's states.
27 struct ONIXS_ICEMDH_EXPORT HandlerStates
28 {
29  /// \copydoc HandlerStates
30  enum Enum
31  {
32  /// The Handler is stopped.
33  Stopped = 0,
34 
35  /// The Handler is stopping.
37 
38  /// The Handler is started but no data processing is performed yet.
40 
41  /// Download of security definition messages is started.
43 
44  /// Download of security definition messages is finished.
46 
47  /// The correct books state is lost.
48  ///
49  /// Handler switches to this state when it joins the market and the
50  /// initial books state is built from multicast messages or when the
51  /// message sequence number gap is detected, so the book state should
52  /// be re-built from multicast messages again.
53  ///
54  /// It should be assumed at this point that all books maintained
55  /// in the Handler may no longer have the correct, latest state
56  /// maintained by ICE, so they are cleared.
58 
59  /// The latest books state is restored.
60  ///
61  /// Handler switches to this state when the the latest books state
62  /// is restored (all snapshot data is retrieved).
63  ///
64  /// It should be assumed at this point that all books maintained in
65  /// the Handler have the correct, latest state maintained by ICE.
67  };
68 
69  /// Returns string representation.
70  static const char* toString(Enum state);
71 };
72 
73 /// States of the Handler in which it may reside.
75 
76 }}}} // namespace MarketData, iMpact, ICE, OnixS
Available Handler's states.
Definition: HandlerState.h:27
HandlerStates::Enum HandlerState
States of the Handler in which it may reside.
Definition: HandlerState.h:74
The Handler is started but no data processing is performed yet.
Definition: HandlerState.h:39
Enum
Available Handler's states.
Definition: HandlerState.h:30
Download of security definition messages is finished.
Definition: HandlerState.h:45