summaryrefslogtreecommitdiff
path: root/apps/Gateway/Gateway/Connection_Handler.h
blob: ea21af476b83bace6beb12011f30dda0179b1c9e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/* -*- C++ -*- */
// $Id$

// ============================================================================
//
// = LIBRARY
//    gateway
// 
// = FILENAME
//    Connection_Handler.h
//
// = AUTHOR
//    Doug Schmidt 
// 
// ============================================================================

#if !defined (_CONNECTION_HANDLER)
#define _CONNECTION_HANDLER

#include "ace/Service_Config.h"
#include "ace/SOCK_Connector.h"
#include "ace/Svc_Handler.h"
#include "Config_Files.h"
#include "Options.h"
#include "Event.h"

// Forward declaration.
class Event_Channel;

class Connection_Handler : public ACE_Svc_Handler<ACE_SOCK_STREAM, ACE_SYNCH>
{
  // = TITLE
  //     <Connection_Handler> contains info about connection state and
  //     addressing.
  //
  // = DESCRIPTION
  //     The <Connection_Handler> classes process events sent to the
  //     Event Channel from Suppliers and forward them to Consumers.
public:
  Connection_Handler (void);
  // Default constructor (needed to make <ACE_Connector> happy).

  Connection_Handler (const Connection_Config_Info &);
  // Real constructor.

  virtual int open (void * = 0);
  // Initialize and activate a single-threaded <Connection_Handler>
  // (called by <ACE_Connector::handle_output>).

  const ACE_INET_Addr &remote_addr (void);
  // Returns the peer's routing address.

  const ACE_INET_Addr &local_addr (void);
  // Returns our local address.

  // = Set/get connection id.
  CONNECTION_ID connection_id (void);
  void connection_id (CONNECTION_ID);

  // = The current state of the Connection_Handler.
  enum State
  {
    IDLE = 1,      // Prior to initialization.
    CONNECTING,    // During connection establishment.
    ESTABLISHED,   // Connection_Handler is established and active.
    DISCONNECTING, // Connection_Handler is in the process of connecting.
    FAILED	   // Connection_Handler has failed.
  };

  // = Set/get the current state.
  void state (State);
  State state (void);

  // = Set/get the current retry timeout delay.
  void timeout (int);
  int timeout (void);

  // = Set/get the maximum retry timeout delay.
  void max_timeout (int);
  int max_timeout (void);

  // = Set/get proxy role (i.e., 'S' for Supplier and 'C' for Consumer
  // (necessary for error checking).
  void connection_role (char);
  char connection_role (void);

  // = The total number of bytes sent/received on this proxy.
  size_t total_bytes (void);
  void total_bytes (size_t bytes);
  // Increment count by <bytes>.

  virtual int handle_timeout (const ACE_Time_Value &, const void *arg);
  // Perform timer-based Connection_Handler reconnection.

  virtual int handle_close (ACE_HANDLE = ACE_INVALID_HANDLE,
			    ACE_Reactor_Mask = ACE_Event_Handler::ALL_EVENTS_MASK);
  // Perform Connection_Handler termination.

protected:
  ACE_INET_Addr remote_addr_;
  // Address of peer.

  ACE_INET_Addr local_addr_;
  // Address of us.

  CONNECTION_ID connection_id_;  
  // The assigned connection ID of this entry.

  size_t total_bytes_;
  // The total number of bytes sent/received on this proxy.

  State state_;
  // The current state of the proxy.

  int timeout_;
  // Amount of time to wait between reconnection attempts.

  int max_timeout_;
  // Maximum amount of time to wait between reconnection attempts.

  char connection_role_;
  // Indicates which role the proxy plays ('S' == Supplier and 'C' ==
  // Consumer).

  Event_Channel *event_channel_;
  // Reference to the <Event_Channel> that we use to forward all
  // the events from Consumers and Suppliers.
};

class Connection_Handler_Factory
{
  // = TITLE
  //     Creates the appropriate type of <Connection_Handler>.
  //
  // = DESCRIPTION
  //     <Connection_Handler>s can include <Consumer_Handler>,
  //     <Supplier_Handler>, <Thr_Consumer_Handler>, or
  //     <Thr_Supplier_Handler>).
public:
  Connection_Handler *make_connection_handler (const Connection_Config_Info &);
  // Make the appropriate type of <Connection_Handler>, based on the
  // <Connection_Config_Info> parameter.
};

#endif /* _CONNECTION_HANDLER */