TAO_Offer_Id_Iterator Class Reference

#include <Offer_Iterators.h>

Collaboration diagram for TAO_Offer_Id_Iterator:

[legend]List of all members.

Public Member Functions
	TAO_Offer_Id_Iterator (void)
	No op constructor.
	~TAO_Offer_Id_Iterator (void)
virtual CORBA::ULong	max_left (void)
virtual void	destroy (void)
virtual CORBA::Boolean	next_n (CORBA::ULong _n, CosTrading::OfferIdSeq_out _ids)
void	insert_id (CosTrading::OfferId new_id)
	Insert a <new_id> into the contents of the iterator.
Private Member Functions
	TAO_Offer_Id_Iterator (const TAO_Offer_Id_Iterator &)
TAO_Offer_Id_Iterator &	operator= (TAO_Offer_Id_Iterator &)
Private Attributes
TAO_String_Queue	ids_

---

Detailed Description

Definition at line 209 of file Offer_Iterators.h.

---

Constructor & Destructor Documentation

TAO_Offer_Id_Iterator::TAO_Offer_Id_Iterator

(

void

)

No op constructor.

Definition at line 194 of file Offer_Iterators.cpp.

{
}

TAO_Offer_Id_Iterator::~TAO_Offer_Id_Iterator

(

void

)

Definition at line 198 of file Offer_Iterators.cpp.

References ACE_Unbounded_Queue< T >::dequeue_head(), ids_, and CORBA::string_free().

{
  int return_value = 0;

  do
    {
      CosTrading::OfferId offer_id = 0;

      return_value = this->ids_.dequeue_head (offer_id);
      if (return_value == 0)
        CORBA::string_free (offer_id);
    }
  while (return_value == 0);
}

TAO_Offer_Id_Iterator::TAO_Offer_Id_Iterator

(

const TAO_Offer_Id_Iterator &

)

[private]

---

Member Function Documentation

void TAO_Offer_Id_Iterator::destroy

(

void

)

[virtual]

The destroy operation destroys the iterator. No further operations can be invoked on an iterator after it has been destroyed.

Definition at line 220 of file Offer_Iterators.cpp.

{
  // Remove self from POA

  PortableServer::POA_var poa =
    this->_default_POA ();

  PortableServer::ObjectId_var id =
    poa->servant_to_id (this);

  poa->deactivate_object (id.in ());
}

void TAO_Offer_Id_Iterator::insert_id

(

CosTrading::OfferId

new_id

)

Insert a <new_id> into the contents of the iterator.

Definition at line 284 of file Offer_Iterators.cpp.

References ACE_Unbounded_Queue< T >::enqueue_tail(), and ids_.

Referenced by TAO_Offer_Database< LOCK_TYPE >::retrieve_all_offer_ids().

{
  this->ids_.enqueue_tail (new_id);
}

CORBA::ULong TAO_Offer_Id_Iterator::max_left

(

void

)

[virtual]

The max_left operation returns the number of offer identifiers remaining in the iterator. The exception UnknownMaxLeft is raised if the iterator cannot determine the remaining number of offer identifiers (e.g., if the iterator determines its set of offer identifiers through lazy evaluation).

Definition at line 214 of file Offer_Iterators.cpp.

References ids_, and ACE_Unbounded_Queue< T >::size().

{
  return static_cast<CORBA::ULong> (this->ids_.size ());
}

CORBA::Boolean TAO_Offer_Id_Iterator::next_n	(	CORBA::ULong	_n,
		CosTrading::OfferIdSeq_out	_ids
	)			[virtual]

The next_n operation returns a set of offer identifiers in the output parameter "ids." The operation returns n offer identifiers if there are at least n offer identifiers remaining in the iterator. If there are fewer than n offer identifiers in the iterator, then all remaining offer identifiers are returned. The actual number of offer identifiers returned can be determined from the length of the "ids" sequence. The next_n operation returns TRUE if there are further offer identifiers to be extracted from the iterator. It returns FALSE if there are no further offer identifiers to be extracted.

Definition at line 234 of file Offer_Iterators.cpp.

References ACE_NEW_RETURN, ACE_Unbounded_Queue< T >::dequeue_head(), ids_, and ACE_Unbounded_Queue< T >::size().

Referenced by TAO_Admin< TRADER_LOCK_TYPE, MAP_LOCK_TYPE >::list_offers().

{
  // Calculate the number of Ids to be returned in this.
  CORBA::ULong items_left = static_cast<CORBA::ULong> (this->ids_.size());
  int difference = items_left - n;
  CORBA::ULong returnable_items = (difference >= 0) ? n : items_left;
  CORBA::Boolean return_value = (CORBA::Boolean) (difference > 0);

  if (returnable_items == 0)
    ACE_NEW_RETURN (_ids,
                    CosTrading::OfferIdSeq,
                    return_value);
  else
    {
      // Allocate space for the returned OfferIds.
      CosTrading::OfferId* id_buf =
        CosTrading::OfferIdSeq::allocbuf (returnable_items);

      if (id_buf != 0)
        {
          // Copy in those ids!
          for (CORBA::ULong i = 0; i < returnable_items; i++)
            {
              CosTrading::OfferId offer_id = 0;

              this->ids_.dequeue_head (offer_id);
              id_buf[i] = offer_id;
            }

          // Place them into an OfferIdSeq.
          ACE_NEW_RETURN (_ids,
                          CosTrading::OfferIdSeq (returnable_items,
                                                  returnable_items,
                                                  id_buf,
                                                  1),
                          return_value);
        }
      else
        ACE_NEW_RETURN (_ids,
                        CosTrading::OfferIdSeq,
                        return_value);
    }

  // Return true only if there are items left to be returned in
  // subsequent calls.
  return return_value;
}

TAO_Offer_Id_Iterator& TAO_Offer_Id_Iterator::operator=

(

TAO_Offer_Id_Iterator &

)

[private]

---

Member Data Documentation

TAO_String_Queue TAO_Offer_Id_Iterator::ids_ [private]

Definition at line 271 of file Offer_Iterators.h.

Referenced by insert_id(), max_left(), next_n(), and ~TAO_Offer_Id_Iterator().

---

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

• Offer_Iterators.h
• Offer_Iterators.cpp

---