summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Notify/Dispatch_Observer_T.h
blob: 84ee9ae6fcaa3b8a668c98cabe7c6941996cd0b0 (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
/* -*- C++ -*- */
/**
 *  @file Dispatch_Observer_T.h
 *
 *  $Id$
 *
 *  @author Pradeep Gore <pradeep@oomworks.com>
 *
 *
 */

#ifndef TAO_NS_DISPATCH_OBSERVER_T_H
#define TAO_NS_DISPATCH_OBSERVER_T_H
#include "ace/pre.h"

#include "notify_export.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

//#include "types.h"
#include "orbsvcs/ESF/ESF_Proxy_Collection.h"

/**
 * @class TAO_NS_Dispatch_Observer_T
 *
 * @brief An observer class that is notified of the success or failure of event/update diapatches.
 *        If a dispatch fails, the PEER is added to a pending list. This list is obtained by the Pending Worker to retry delivery of
 *        Events/Updates. When the max_retries are reached, the observer destroys the proxy.
 *
 */
template <class PEER>
class TAO_Notify_Export TAO_NS_Dispatch_Observer_T
{
public:
  typedef TAO_ESF_Proxy_Collection<PEER> PEER_COLLECTION;

  /// Constuctor
  TAO_NS_Dispatch_Observer_T (void);

  /// Destructor
  ~TAO_NS_Dispatch_Observer_T ();

  /// Init
  void init (ACE_ENV_SINGLE_ARG_DECL);

  void max_retry_attempts (int max_retry_attempts);

  /// Enqueue this peer.
  void enqueue (PEER* peer  ACE_ENV_ARG_DECL);

  /// Dispatch failure notice.
  void dispatch_failure (PEER* peer, int retry_count ACE_ENV_ARG_DECL);

  /// Dispatch success notice.
  void dispatch_success (PEER* peer ACE_ENV_ARG_DECL);

  /// Get peer collection.
  PEER_COLLECTION* peer_collection (void);

protected:
  /// Max retry attempts.
  int max_retry_attempts_;

  /// Pending list.
  PEER_COLLECTION* peer_collection_;
};

#if defined (__ACE_INLINE__)
#include "Dispatch_Observer_T.inl"
#endif /* __ACE_INLINE__ */

#if defined (ACE_TEMPLATES_REQUIRE_SOURCE)
#include "Dispatch_Observer_T.cpp"
#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */

#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA)
#pragma implementation ("Dispatch_Observer_T.cpp")
#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */

#include "ace/post.h"
#endif /* TAO_NS_DISPATCH_OBSERVER_T_H */