OnixS C++ FIX Engine  4.7.0
API Documentation
InputDataTraits.h
Go to the documentation of this file.
1 /*
2 * Copyright Onix Solutions Limited [OnixS]. All rights reserved.
3 *
4 * This software owned by Onix Solutions Limited [OnixS] 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 namespace OnixS {
23 namespace FIX {
24 namespace FAST {
25 
26 /// @brief Characteristics of the input data stream for decoding.
27 ///
28 /// This enumeration allows to setup decoder in dependent-decoding (i.e. @c decodeEachMessageIndependently == false) mode for particular characteristics of the input data stream.
29 ///
30 /// @ref CompleteMessagesOnly allows to perform decoding faster, but requires explicit call of Decoder::reset when someone error occurs or
31 /// Decoder::decode returns NULL. Decoder::decode() will fire exception if such reset was omitted after exception.
32 ///
33 /// This commonly prohibits usage of the mode for decoding streaming data like TCP/IP stream. On another hand the mode is highly recommended for the data distributed via
34 /// UDP multicast or other packet transport which requires reset of decoder at someone strongly determined points.
35 ///
36 /// @ref CouldContainPartialMessages initiates a bit slower decoding then @ref CompleteMessagesOnly but could be used for stream data decoding using following method:
37 /// @code
38 /// Decoder decoder(templates, dictionary, false, InputDataTraits::CouldContainPartialMessages);
39 /// ...
40 /// const Message *message = 0;
41 /// while(!message) {
42 /// /* consume some data */
43 /// decoder.tryDecode(buffer, offset, count, &message, &numberOfDecodedBytes);
44 /// }
45 /// @endcode
47  enum Enum {
48  /// Faster decoding but requires explicit decoder reset when error occurs.
50 
51  /// Slower decoding, allows to try to decode incomplete messages as well as handling of wrong/damaged data without subsequent explicit reset.
53  };
54 };
55 }
56 }
57 }
Slower decoding, allows to try to decode incomplete messages as well as handling of wrong/damaged dat...
Faster decoding but requires explicit decoder reset when error occurs.
Characteristics of the input data stream for decoding.