OnixS C++ B3 BOE Binary Order Entry  1.2.0
API Documentation
SessionReactor.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 
23 
24 namespace OnixS {
25 namespace B3 {
26 namespace BOE {
27 
28 /// Network reactor type.
29 struct ReactorType {
30  enum Enum {
31  /// Undefined reactor.
32  Undefined = 0,
33 
34  /// Solarflare TCPDirect reactor.
35  TcpDirect = 1,
36 
37  /// Standard TCP reactor.
39  };
40 };
41 
42 /// Session's network stack reactor interface.
44 {
45 public:
46  /// Destructor.
48 
49  /// Processes events on a stack and performs the necessary handling.
50  ///
51  /// These events, including transmit and receive events raised by the hardware,
52  /// and also software events such as TCP and FIXP protocol timers.
53  virtual void dispatchEvents() = 0;
54 
55  /// \return a boolean value indicating whether a stack is quiescent.
56  virtual bool isQuiescent() const = 0;
57 
58  /// \return the ID of the thread that created the stack.
59  virtual Threading::ThreadId workingThreadId() const ONIXS_B3_BOE_NOTHROW = 0;
60 
61  /// \return the type of the stack.
62  virtual ReactorType::Enum type() const ONIXS_B3_BOE_NOTHROW = 0;
63 };
64 }
65 }
66 }
pthread_t ThreadId
Type alias for thread identifier.
Definition: Definitions.h:34
#define ONIXS_B3_BOE_NOTHROW
Definition: Compiler.h:182
#define ONIXS_B3_BOE_EXPORTED
Definition: Compiler.h:181
Session's network stack reactor interface.
Definition: Defines.h:40
#define ONIXS_B3_BOE_DEFAULT
Definition: Compiler.h:208
Network reactor type.
Solarflare TCPDirect reactor.