summaryrefslogtreecommitdiff
path: root/TAO/tao/IIOP_Endpoint.h
diff options
context:
space:
mode:
Diffstat (limited to 'TAO/tao/IIOP_Endpoint.h')
-rw-r--r--TAO/tao/IIOP_Endpoint.h94
1 files changed, 46 insertions, 48 deletions
diff --git a/TAO/tao/IIOP_Endpoint.h b/TAO/tao/IIOP_Endpoint.h
index 4bb5672466d..688bddeea46 100644
--- a/TAO/tao/IIOP_Endpoint.h
+++ b/TAO/tao/IIOP_Endpoint.h
@@ -1,22 +1,19 @@
// This may look like C, but it's really -*- C++ -*-
-// $Id$
-
-
-// ============================================================================
-//
-// = LIBRARY
-// TAO
-//
-// = FILENAME
-// IIOP_Endpoint.h
-//
-// = DESCRIPTION
-// IIOP implementation of PP Framework Endpoint interface.
-//
-// = AUTHOR
-// Marina Spivak <marina@cs.wustl.edu>
-//
-// ============================================================================
+
+
+//=============================================================================
+/**
+ * @file IIOP_Endpoint.h
+ *
+ * $Id$
+ *
+ * IIOP implementation of PP Framework Endpoint interface.
+ *
+ *
+ * @author Marina Spivak <marina@cs.wustl.edu>
+ */
+//=============================================================================
+
#ifndef TAO_IIOP_ENDPOINT_H
#define TAO_IIOP_ENDPOINT_H
@@ -35,14 +32,15 @@
class TAO_IIOP_Connection_Handler;
+/**
+ * @class TAO_IIOP_Endpoint
+ *
+ * @brief TAO_IIOP_Endpoint
+ *
+ * IIOP-specific implementation of PP Framework Endpoint interface.
+ */
class TAO_Export TAO_IIOP_Endpoint : public TAO_Endpoint
{
- // = TITLE
- // TAO_IIOP_Endpoint
- //
- // = DESCRIPTION
- // IIOP-specific implementation of PP Framework Endpoint interface.
- //
public:
friend class TAO_IIOP_Profile;
@@ -50,26 +48,26 @@ public:
// = Initialization and termination methods.
+ /// Default constructor.
TAO_IIOP_Endpoint (void);
- // Default constructor.
+ /// Constructor. This is the most efficient constructor since it
+ /// does not require any address resolution processing.
TAO_IIOP_Endpoint (const char *host,
CORBA::UShort port,
const ACE_INET_Addr &addr);
- // Constructor. This is the most efficient constructor since it
- // does not require any address resolution processing.
+ /// Constructor.
TAO_IIOP_Endpoint (const ACE_INET_Addr &addr,
int use_dotted_decimal_addresses);
- // Constructor.
+ /// Constructor. This constructor is used when decoding endpoints.
TAO_IIOP_Endpoint (const char *host,
CORBA::UShort port,
CORBA::Short priority);
- // Constructor. This constructor is used when decoding endpoints.
+ /// Destructor.
~TAO_IIOP_Endpoint (void);
- // Destructor.
// = Implementation of abstract TAO_Endpoint methods. See
// Endpoint.h for their documentation.
@@ -78,55 +76,55 @@ public:
virtual int addr_to_string (char *buffer, size_t length);
virtual void reset_hint (void);
+ /// Makes a copy of <this>
virtual TAO_Endpoint *duplicate (void);
- // Makes a copy of <this>
+ /// Return true if this endpoint is equivalent to <other_endpoint>. Two
+ /// endpoints are equivalent iff their port and host are the same.
CORBA::Boolean is_equivalent (const TAO_Endpoint *other_endpoint);
- // Return true if this endpoint is equivalent to <other_endpoint>. Two
- // endpoints are equivalent iff their port and host are the same.
+ /// Return a hash value for this object.
CORBA::ULong hash (void);
- // Return a hash value for this object.
// Allocates memory and returns a copy of <this>
// = IIOP_Endpoint-specific methods.
+ /// Return a reference to the <object_addr>.
const ACE_INET_Addr &object_addr (void) const;
- // Return a reference to the <object_addr>.
+ /// Return a pointer to the host string. This object maintains
+ /// ownership of this string.
const char *host (void) const;
- // Return a pointer to the host string. This object maintains
- // ownership of this string.
+ /// Copy the string <h> into <host_> and return the resulting pointer.
+ /// This object maintains ownership of this string.
const char *host (const char *h);
- // Copy the string <h> into <host_> and return the resulting pointer.
- // This object maintains ownership of this string.
+ /// Return the port number.
CORBA::UShort port (void) const;
- // Return the port number.
+ /// Set the port number.
CORBA::UShort port (CORBA::UShort p);
- // Set the port number.
//TAO_IIOP_Connection_Handler *&hint (void);
// Access to our <hint_>.
private:
+ /// Helper method for setting INET_Addr.
int set (const ACE_INET_Addr &addr,
int use_dotted_decimal_addresses);
- // Helper method for setting INET_Addr.
+ /// String representing the host name.
CORBA::String_var host_;
- // String representing the host name.
+ /// TCP port number.
CORBA::UShort port_;
- // TCP port number.
+ /// Cached instance of <ACE_INET_Addr> for use in making
+ /// invocations, etc.
ACE_INET_Addr object_addr_;
- // Cached instance of <ACE_INET_Addr> for use in making
- // invocations, etc.
// TAO_IIOP_Client_Connection_Handler *hint_;
// Hint indicating the last successfully used connection handler for
@@ -134,9 +132,9 @@ private:
// @@ This needs to be used for optimization. Will look in to this
// after MS defense - Bala
+ /// IIOP Endpoints can be stringed into a list. Return the next
+ /// endpoint in the list, if any.
TAO_IIOP_Endpoint *next_;
- // IIOP Endpoints can be stringed into a list. Return the next
- // endpoint in the list, if any.
};
#if defined (__ACE_INLINE__)