summaryrefslogtreecommitdiff
path: root/TAO/tao/Endpoint.h
diff options
context:
space:
mode:
authorOssama Othman <ossama-othman@users.noreply.github.com>2003-02-20 17:50:09 +0000
committerOssama Othman <ossama-othman@users.noreply.github.com>2003-02-20 17:50:09 +0000
commit6960ce41e6d742387dd64136d09eb822304ef50d (patch)
treee525bff1d716f4a9b884898cb87db5ef7d1200cb /TAO/tao/Endpoint.h
parent7910287d755f04a87eeae6e9e9614cf313da35cd (diff)
downloadATCD-6960ce41e6d742387dd64136d09eb822304ef50d.tar.gz
ChangeLogTag:Thu Feb 20 09:07:56 2003 Ossama Othman <ossama@uci.edu>
Diffstat (limited to 'TAO/tao/Endpoint.h')
-rw-r--r--TAO/tao/Endpoint.h51
1 files changed, 32 insertions, 19 deletions
diff --git a/TAO/tao/Endpoint.h b/TAO/tao/Endpoint.h
index 71dfacb6bd2..35ab66a7268 100644
--- a/TAO/tao/Endpoint.h
+++ b/TAO/tao/Endpoint.h
@@ -60,22 +60,31 @@ public:
/// <priority_> attribute getter.
CORBA::Short priority (void) const;
- // = Abstract methods to be implemented by concrete subclasses.
-
- /// Return true if this endpoint is equivalent to <other_endpoint>. Two
- /// endpoints are equivalent iff their port and host are the same.
+ /**
+ * @name TAO_Endpoint Template Methods
+ *
+ * Abstract methods to be implemented by concrete subclasses.
+ */
+ //@{
+ /**
+ * @return true if this endpoint is equivalent to @a other_endpoint.
+ */
virtual CORBA::Boolean is_equivalent (const TAO_Endpoint *other_endpoint) = 0;
- /// Endpoints can be stringed in a list. Return the next endpoint in
- /// the list, if any.
+ /// Endpoints can be stringed in a list.
+ /**
+ * @return The next endpoint in the list, if any.
+ */
virtual TAO_Endpoint *next (void) = 0;
+ /// Return a string representation for the address.
/**
- * Return a string representation for the address. Returns
- * -1 if buffer is too small. The purpose of this method is to
- * provide a general interface to the underlying address object's
- * addr_to_string method. This allows the protocol implementor to
- * select the appropriate string format.
+ * The purpose of this method is to provide a general interface to
+ * the underlying address object's @c addr_to_string method. This
+ * allows the protocol implementor to select the appropriate string
+ * format.
+ *
+ * @return -1 if buffer is too small.
*/
virtual int addr_to_string (char *buffer, size_t length) = 0;
@@ -83,8 +92,8 @@ public:
/// the hint to be cleaned up and reset to NULL.
virtual void reset_hint (void) = 0;
- /// This method returns a copy of the corresponding endpoints by
- /// allocation memory
+ /// This method returns a deep copy of the corresponding endpoints by
+ /// allocating memory.
virtual TAO_Endpoint *duplicate (void) = 0;
/// Return a hash value for this object.
@@ -93,11 +102,13 @@ public:
protected:
/// Lock for the address lookup.
- /// @@todo: This lock should be strategised so that we dont lock in
- /// single threaded configurations. I am not able to do this now as
- /// most of the information is available in the ORB_Core which is
- /// not available here...
- TAO_SYNCH_MUTEX addr_lookup_lock_;
+ /**
+ * @todo This lock should be strategized so that we dont lock in
+ * single threaded configurations. It is not possible to do
+ * this now as most of the information is available in the
+ * ORB_Core which is not available here.
+ */
+ mutable TAO_SYNCH_MUTEX addr_lookup_lock_;
private:
@@ -105,6 +116,8 @@ private:
ACE_UNIMPLEMENTED_FUNC (TAO_Endpoint (const TAO_Endpoint&))
ACE_UNIMPLEMENTED_FUNC (void operator= (const TAO_Endpoint&))
+private:
+
/// IOP tag, identifying the protocol for which this endpoint
/// contains addressing info.
CORBA::ULong tag_;
@@ -116,9 +129,9 @@ private:
*/
CORBA::Short priority_;
-
};
+
#if defined (__ACE_INLINE__)
# include "tao/Endpoint.i"
#endif /* __ACE_INLINE__ */