TAO_Asynch_Queued_Message Class Reference

Specialize TAO_Queued_Message for asynch requests, i.e. oneways sent with SYNC_NONE policy. More...

#include <Asynch_Queued_Message.h>

Inheritance diagram for TAO_Asynch_Queued_Message:

[legend]Collaboration diagram for TAO_Asynch_Queued_Message:

[legend]List of all members.

Public Member Functions
	TAO_Asynch_Queued_Message (const ACE_Message_Block *contents, TAO_ORB_Core *oc, ACE_Time_Value *timeout, ACE_Allocator *alloc, bool is_heap_allocated)
	Constructor.
virtual	~TAO_Asynch_Queued_Message (void)
	Destructor.
Implement the Template Methods from TAO_Queued_Message
virtual size_t	message_length (void) const
	Return the length of the message.
virtual int	all_data_sent (void) const
	Return 1 if all the data has been sent.
virtual void	fill_iov (int iovcnt_max, int &iovcnt, iovec iov[]) const
	Fill up an io vector using the connects of the message.
virtual void	bytes_transferred (size_t &byte_count)
	Update the internal state, data has been sent.
virtual TAO_Queued_Message *	clone (ACE_Allocator *alloc)
virtual void	destroy (void)
	Reclaim resources.
virtual bool	is_expired (const ACE_Time_Value &now) const
	Check for timeout.
Protected Member Functions
	TAO_Asynch_Queued_Message (char *buf, TAO_ORB_Core *oc, size_t size, const ACE_Time_Value &abs_timeout, ACE_Allocator *alloc, bool is_heap_allocated)
	Constructor.
Private Attributes
size_t const	size_
	The number of bytes in the buffer.
size_t	offset_
	The offset in the buffer.
char *	buffer_
	The buffer containing the complete message.
ACE_Time_Value	abs_timeout_

---

Detailed Description

Specialize TAO_Queued_Message for asynch requests, i.e. oneways sent with SYNC_NONE policy.

Definition at line 39 of file Asynch_Queued_Message.h.

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_Asynch_Queued_Message::TAO_Asynch_Queued_Message	(	const ACE_Message_Block *	contents,
		TAO_ORB_Core *	oc,
		ACE_Time_Value *	timeout,
		ACE_Allocator *	alloc,
		bool	is_heap_allocated
	)

Constructor.

Parameters:

	contents	The message block chain that must be sent.
	alloc	Allocator used for creating this object.
	timeout	The relative timeout after which this message should be expired.

Todo:

I'm almost sure this class will require a callback interface for AMIs sent with SYNC_NONE policy. Those guys need to hear when the connection timeouts or closes, but cannot block waiting for the message to be delivered.

Definition at line 19 of file Asynch_Queued_Message.cpp.

References ACE_NEW, ACE_High_Res_Timer::gettimeofday_hr(), and ACE_OS::memcpy().

  : TAO_Queued_Message (oc, alloc, is_heap_allocated)
  , size_ (contents->total_length ())
  , offset_ (0)
  , abs_timeout_ (ACE_Time_Value::zero)
{
  if (timeout != 0)// && *timeout != ACE_Time_Value::zero)
    this->abs_timeout_ = ACE_High_Res_Timer::gettimeofday_hr () + *timeout;
  // @@ Use a pool for these guys!!
  ACE_NEW (this->buffer_, char[this->size_]);

  size_t copy_offset = 0;
  for (const ACE_Message_Block *i = contents;
       i != 0;
       i = i->cont ())
    {
      ACE_OS::memcpy (this->buffer_ + copy_offset,
                      i->rd_ptr (),
                      i->length ());
      copy_offset += i->length ();
    }
}

TAO_Asynch_Queued_Message::~TAO_Asynch_Queued_Message

(

void

)

[virtual]

Destructor.

Definition at line 61 of file Asynch_Queued_Message.cpp.

References buffer_.

{
  // @@ Use a pool for these guys!
  delete [] this->buffer_;
}

TAO_Asynch_Queued_Message::TAO_Asynch_Queued_Message	(	char *	buf,
		TAO_ORB_Core *	oc,
		size_t	size,
		const ACE_Time_Value &	abs_timeout,
		ACE_Allocator *	alloc,
		bool	is_heap_allocated
	)			[protected]

Constructor.

Parameters:

	buf	The buffer that needs to be sent on the wire. The buffer will be owned by this class. The buffer will be deleted when the destructor is called and hence the buffer should always come off the heap!
	oc	The ORB Core
	size	The size of the buffer <buf> that is being handed over.
	abs_timeout	The time after which this message should be expired.
	alloc	Allocator used for creating <this> object.

Definition at line 47 of file Asynch_Queued_Message.cpp.

  : TAO_Queued_Message (oc, alloc, is_heap_allocated)
  , size_ (size)
  , offset_ (0)
  , buffer_ (buf)
  , abs_timeout_ (abs_timeout)
{
}

---

Member Function Documentation

int TAO_Asynch_Queued_Message::all_data_sent

(

void

)

const [virtual]

Return 1 if all the data has been sent.

Implements TAO_Queued_Message.

Definition at line 74 of file Asynch_Queued_Message.cpp.

References offset_, and size_.

{
  return this->size_ == this->offset_;
}

void TAO_Asynch_Queued_Message::bytes_transferred

(

size_t &

byte_count

)

[virtual]

Update the internal state, data has been sent.

After the TAO_Transport class completes a successful (or partially successful) I/O operation it must update the state of all the messages queued. This callback method is used by each message to update its state and determine if all the data has been sent already.

Parameters:

byte_count

The number of bytes succesfully sent. The TAO_Queued_Message should decrement this value by the number of bytes that must still be sent.

Returns:

Returns 1 if the TAO_Queued_Message has any more data to send.

Implements TAO_Queued_Message.

Definition at line 93 of file Asynch_Queued_Message.cpp.

References TAO_LF_Event::LFS_ACTIVE, TAO_LF_Event::LFS_SUCCESS, offset_, size_, and TAO_LF_Invocation_Event::state_changed_i().

{
  this->state_changed_i (TAO_LF_Event::LFS_ACTIVE);

  size_t const remaining_bytes = this->size_ - this->offset_;
  if (byte_count > remaining_bytes)
    {
      this->offset_ = this->size_;
      byte_count -= remaining_bytes;
      return;
    }
  this->offset_ += byte_count;
  byte_count = 0;

  if (this->all_data_sent ())
    this->state_changed (TAO_LF_Event::LFS_SUCCESS,
                         this->orb_core_->leader_follower ());
}

TAO_Queued_Message * TAO_Asynch_Queued_Message::clone

(

ACE_Allocator *

alloc

)

[virtual]

Note:

No reason to believe why this would be called. But have it here for the sake of uniformity.

Implements TAO_Queued_Message.

Definition at line 114 of file Asynch_Queued_Message.cpp.

References ACE_DEBUG, ACE_NEW_MALLOC_RETURN, ACE_NEW_RETURN, LM_DEBUG, ACE_Allocator::malloc(), ACE_OS::memcpy(), offset_, size_, and TAO_debug_level.

{
  char *buf = 0;

  // @todo: Need to use a memory pool. But certain things need to
  // change a bit in this class for that. Till then.

  // Just allocate and copy data that needs to be sent, no point
  // copying the whole buffer.
  size_t const sz = this->size_ - this->offset_;

  ACE_NEW_RETURN (buf,
                  char[sz],
                  0);

  ACE_OS::memcpy (buf,
                  this->buffer_ + this->offset_,
                  sz);

  TAO_Asynch_Queued_Message *qm = 0;

  if (alloc)
    {
      ACE_NEW_MALLOC_RETURN (qm,
                             static_cast<TAO_Asynch_Queued_Message *> (
                                 alloc->malloc (sizeof (TAO_Asynch_Queued_Message))),
                             TAO_Asynch_Queued_Message (buf,
                                                        this->orb_core_,
                                                        sz,
                                                        this->abs_timeout_,
                                                        alloc,
                                                        true),
                             0);
    }
  else
    {
      // No allocator, so use the common heap!
      if (TAO_debug_level == 4)
        {
          // This debug is for testing purposes!
          ACE_DEBUG ((LM_DEBUG,
                      "TAO (%P|%t) - Asynch_Queued_Message::clone\n"
                      "Using global pool for allocation \n"));
        }

      ACE_NEW_RETURN (qm,
                      TAO_Asynch_Queued_Message (buf,
                                                 this->orb_core_,
                                                 sz,
                                                 this->abs_timeout_,
                                                 0,
                                                 true),
                      0);
    }

  return qm;
}

void TAO_Asynch_Queued_Message::destroy

(

void

)

[virtual]

Reclaim resources.

Reliable messages are allocated from the stack, thus they do not be deallocated. Asynchronous (SYNC_NONE) messages are allocated from the heap (or a pool), they need to be reclaimed explicitly.

Implements TAO_Queued_Message.

Definition at line 173 of file Asynch_Queued_Message.cpp.

References ACE_DES_FREE.

{
  if (this->is_heap_created_)
    {
      // If we have an allocator release the memory to the allocator
      // pool.
      if (this->allocator_)
        {
          ACE_DES_FREE (this,
                        this->allocator_->free,
                        TAO_Asynch_Queued_Message);

        }
      else // global release..
        {
          delete this;
        }
    }
}

void TAO_Asynch_Queued_Message::fill_iov	(	int	iovcnt_max,
		int &	iovcnt,
		iovec	iov[]
	)			const [virtual]

Fill up an io vector using the connects of the message.

Different versions of this class represent the message using either a single buffer, or a message block. This method allows a derived class to fill up the contents of an io vector, the TAO_Transport class uses this method to group as many messages as possible in an iovector before sending them to the OS I/O subsystem.

Parameters:

	iovcnt_max	The number of elements in iov
	iovcnt	The number of elements already used by iov, this method should update this counter
	iov	The io vector

Implements TAO_Queued_Message.

Definition at line 80 of file Asynch_Queued_Message.cpp.

References ACE_ASSERT, buffer_, offset_, and size_.

{
  ACE_ASSERT (iovcnt_max > iovcnt);
  ACE_UNUSED_ARG (iovcnt_max); // not used if ACE_ASSERT() is empty

  iov[iovcnt].iov_base = this->buffer_ + this->offset_;
  iov[iovcnt].iov_len  = static_cast<u_long> (this->size_ - this->offset_);
  ++iovcnt;
}

bool TAO_Asynch_Queued_Message::is_expired

(

const ACE_Time_Value &

now

)

const [virtual]

Check for timeout.

Parameters:

now

Pass in the current time using ACE_High_Res_Timer::gettimeofday_hr(). This is a parameter in order to avoid calling gettimeofday_hr() inside of this method (which will be called in a tight loop).

Returns:

true if the relative roundtrip timeout has expired.

Reimplemented from TAO_Queued_Message.

Definition at line 194 of file Asynch_Queued_Message.cpp.

References abs_timeout_, and ACE_Time_Value::zero.

{
  if (this->abs_timeout_ > ACE_Time_Value::zero)
    {
      if (this->offset_ > 0)
        {
          return false; //never expire partial messages
        }
      return this->abs_timeout_ < now;
    }
  return false;
}

size_t TAO_Asynch_Queued_Message::message_length

(

void

)

const [virtual]

Return the length of the message.

If the message has been partially sent it returns the number of bytes that are still not sent.

Implements TAO_Queued_Message.

Definition at line 68 of file Asynch_Queued_Message.cpp.

References offset_, and size_.

{
  return this->size_ - this->offset_;
}

---

Member Data Documentation

ACE_Time_Value TAO_Asynch_Queued_Message::abs_timeout_ [private]

Definition at line 119 of file Asynch_Queued_Message.h.

Referenced by is_expired().

char* TAO_Asynch_Queued_Message::buffer_ [private]

The buffer containing the complete message.

Definition at line 116 of file Asynch_Queued_Message.h.

Referenced by fill_iov(), and ~TAO_Asynch_Queued_Message().

size_t TAO_Asynch_Queued_Message::offset_ [private]

The offset in the buffer.

Data up to offset has been sent already, only the [offset_,size_) range remains to be sent.

Definition at line 113 of file Asynch_Queued_Message.h.

Referenced by all_data_sent(), bytes_transferred(), clone(), fill_iov(), and message_length().

size_t const TAO_Asynch_Queued_Message::size_ [private]

The number of bytes in the buffer.

Definition at line 106 of file Asynch_Queued_Message.h.

Referenced by all_data_sent(), bytes_transferred(), clone(), fill_iov(), and message_length().

---

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

• Asynch_Queued_Message.h
• Asynch_Queued_Message.cpp

---