OpenDDS::DCPS::PriorityKey Class Reference

Encapsulate a priority value and internet address as a key. More...

#include <PriorityKey.h>

Collaboration diagram for OpenDDS::DCPS::PriorityKey:

[legend]

List of all members.

Public Member Functions
	PriorityKey ()
	PriorityKey (Priority priority, ACE_INET_Addr address, bool is_loopback, bool active)
bool	operator< (const PriorityKey &rhs) const
bool	operator== (const PriorityKey &rhs) const
unsigned long	hash () const
Priority &	priority ()
Priority	priority () const
ACE_INET_Addr &	address ()
ACE_INET_Addr	address () const
bool &	is_loopback ()
bool	is_loopback () const
bool &	is_active ()
bool	is_active () const
Private Attributes
Priority	priority_
ACE_INET_Addr	address_
bool	is_loopback_
bool	is_active_

---

Detailed Description

Encapsulate a priority value and internet address as a key.

This class is encapsulates a priority value and an internet address value for use as a key in either an STL container or an ACE hash container. The '<' operator is used by the STL containers and the '==' operator and hash() method are used by the ACE hash map container(s). The ACE hash map container(s) also require the use of a default constructor as well.

To use keys of this type as an STL container key, simply include this type as the key template parameter. An example usage is:

typedef std::map<PriorityKey, ValueType> PriorityMap;

To use this type as an ACE hash container key, use the function object templates ACE_Hash and ACE_Equal_To for the HASH_KEY and COMPARE_KEYS template parameters. An example usage is:

typedef ACE_Hash_Map_Manager_Ex< PriorityKey, ValueType, ACE_Hash<PriorityKey>, ACE_Equal_To<PriorityKey>, SynchType > PriorityHashMap;

Default copy constructor and assigment are sufficient. Readonly and read/write accessors for member data are provided.

Definition at line 52 of file PriorityKey.h.

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::PriorityKey::PriorityKey

(

)

Definition at line 14 of file PriorityKey.inl.

  : priority_(0), is_loopback_(false), is_active_(false)
{
}

ACE_INLINE OpenDDS::DCPS::PriorityKey::PriorityKey	(	Priority	priority,
		ACE_INET_Addr	address,
		bool	is_loopback,
		bool	active
	)

Definition at line 20 of file PriorityKey.inl.

  : priority_(priority), address_(address), is_loopback_(is_loopback), is_active_(active)
{
}

---

Member Function Documentation

ACE_INLINE ACE_INET_Addr OpenDDS::DCPS::PriorityKey::address

(

void

)

const

Definition at line 79 of file PriorityKey.inl.

References address_.

{
  return this->address_;
}

ACE_INLINE ACE_INET_Addr & OpenDDS::DCPS::PriorityKey::address

(

void

)

Definition at line 72 of file PriorityKey.inl.

References address_.

Referenced by OpenDDS::DCPS::TcpTransport::accept_datalink(), and OpenDDS::DCPS::TcpTransport::connect_datalink().

{
  return this->address_;
}

Here is the caller graph for this function:

ACE_INLINE unsigned long OpenDDS::DCPS::PriorityKey::hash

(

void

)

const

Definition at line 50 of file PriorityKey.inl.

References address_, ACE_INET_Addr::hash(), is_active_, is_loopback_, and priority_.

{
  return (this->priority_ << 16) + this->address_.hash() + this->is_loopback_
    + this->is_active_;
}

Here is the call graph for this function:

ACE_INLINE bool OpenDDS::DCPS::PriorityKey::is_active

(

)

const

Definition at line 107 of file PriorityKey.inl.

References is_active_.

{
  return this->is_active_;
}

ACE_INLINE bool & OpenDDS::DCPS::PriorityKey::is_active

(

)

Definition at line 100 of file PriorityKey.inl.

References is_active_.

Referenced by OpenDDS::DCPS::TcpTransport::accept_datalink(), and OpenDDS::DCPS::TcpTransport::connect_datalink().

{
  return this->is_active_;
}

Here is the caller graph for this function:

ACE_INLINE bool OpenDDS::DCPS::PriorityKey::is_loopback

(

void

)

const

Definition at line 93 of file PriorityKey.inl.

References is_loopback_.

{
  return this->is_loopback_;
}

ACE_INLINE bool & OpenDDS::DCPS::PriorityKey::is_loopback

(

void

)

Definition at line 86 of file PriorityKey.inl.

References is_loopback_.

Referenced by OpenDDS::DCPS::TcpTransport::accept_datalink(), and OpenDDS::DCPS::TcpTransport::connect_datalink().

{
  return this->is_loopback_;
}

Here is the caller graph for this function:

ACE_INLINE bool OpenDDS::DCPS::PriorityKey::operator<

(

const PriorityKey &

rhs

)

const

Definition at line 27 of file PriorityKey.inl.

References address_, is_active_, is_loopback_, and priority_.

{
  return (this->address_ < rhs.address_)? true:
         (rhs.address_ < this->address_)? false:
         this->priority_ < rhs.priority_? true:
         (rhs.priority_ < this->priority_)? false :
         (this->is_loopback_ != rhs.is_loopback_) ? rhs.is_loopback_ :
         (this->is_active_ != rhs.is_active_) ? rhs.is_active_ :
         false;
}

ACE_INLINE bool OpenDDS::DCPS::PriorityKey::operator==

(

const PriorityKey &

rhs

)

const

Definition at line 40 of file PriorityKey.inl.

References address_, is_active_, is_loopback_, and priority_.

{
  return (this->priority_ == rhs.priority_)
         && (this->address_ == rhs.address_)
         && (this->is_loopback_ == rhs.is_loopback_)
         && (this->is_active_ == rhs.is_active_);
}

ACE_INLINE Priority OpenDDS::DCPS::PriorityKey::priority

(

void

)

const

Definition at line 65 of file PriorityKey.inl.

References priority_.

{
  return this->priority_;
}

ACE_INLINE Priority & OpenDDS::DCPS::PriorityKey::priority

(

void

)

Definition at line 58 of file PriorityKey.inl.

References priority_.

Referenced by OpenDDS::DCPS::TcpTransport::accept_datalink(), and OpenDDS::DCPS::TcpTransport::connect_datalink().

{
  return this->priority_;
}

Here is the caller graph for this function:

---

Member Data Documentation

ACE_INET_Addr OpenDDS::DCPS::PriorityKey::address_ [private]

Definition at line 88 of file PriorityKey.h.

Referenced by address(), hash(), operator<(), and operator==().

bool OpenDDS::DCPS::PriorityKey::is_active_ [private]

Definition at line 91 of file PriorityKey.h.

Referenced by hash(), is_active(), operator<(), and operator==().

bool OpenDDS::DCPS::PriorityKey::is_loopback_ [private]

Definition at line 90 of file PriorityKey.h.

Referenced by hash(), is_loopback(), operator<(), and operator==().

Priority OpenDDS::DCPS::PriorityKey::priority_ [private]

Definition at line 85 of file PriorityKey.h.

Referenced by hash(), operator<(), operator==(), and priority().

---

The documentation for this class was generated from the following files:

• PriorityKey.h
• PriorityKey.inl