summaryrefslogtreecommitdiff
path: root/ace/CORBA_Ref.h
blob: a93a4412f39f65cfc9275dde9f994054aef1b328 (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
/* -*- C++ -*- */
// $Id$


// ============================================================================
//
// = LIBRARY
//    ace
//
// = FILENAME
//    CORBA_Ref.h
//
// = AUTHOR
//    Irfan Pyarali (irfan@wuerl.wustl.edu).
//    Tim Harrison (harrison@cs.wustl.edu)
//
// = DESCRIPTION
//    A wrapper for helping with Orbix object references.
//
// ============================================================================

#if !defined (ACE_CORBA_REF_H)
#define ACE_CORBA_REF_H

#include "ace/ACE.h"

template <class CORBA_REF>
class ACE_CORBA_Ref
{
  // = TITLE
  //    A wrapper for helping with orbix object references.
  //
  // = DESCRIPTION
  //    ACE_CORBA_Ref is parameterized by the type of orbix object
  //    reference to be used.  The construtor, operator=, and the
  //    destructor of ACE_CORBA_Ref perform implicit duplicates and
  //    releases in order to help make the use of orbix object
  //    references transparent.
public:
  ACE_CORBA_Ref (void);
  // Null construction.

  ACE_CORBA_Ref (CORBA_REF *ref);
  // Contruction with an orbix ref.
  // performs a ref->_duplicate().

  CORBA_REF *operator= (CORBA_REF *ref);
  // Assignment performs a ref->_duplicate().

  operator CORBA_REF *(void) const;
  // Type operator

  CORBA_REF *operator-> (void) const;
  // Smart pointer to forward all CORBA_REF calls to the underlying
  // orbix reference.

  int operator== (CORBA_REF *) const;
  // Pointer comparison.

  int operator!= (CORBA_REF *) const;
  // Pointer comparison.

  ~ACE_CORBA_Ref (void);
  // Destruction: calls ref_->_release

private:
  CORBA_REF *ref_;
};

#if defined (__ACE_INLINE__)
#include "ace/CORBA_Ref.i"
#endif /* __ACE_INLINE__ */

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

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

#endif /* CORBA_REF_H */