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:

Inheritance graph
[legend]
Collaboration diagram for TAO_Asynch_Queued_Message:

Collaboration graph
[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_Messageclone (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.

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.

TAO_Asynch_Queued_Message::~TAO_Asynch_Queued_Message ( void   )  [virtual]

Destructor.

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.


Member Function Documentation

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.

int TAO_Asynch_Queued_Message::all_data_sent ( void   )  const [virtual]

Return 1 if all the data has been sent.

Implements TAO_Queued_Message.

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.

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.

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.

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.

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.


Member Data Documentation

size_t const TAO_Asynch_Queued_Message::size_ [private]

The number of bytes in the buffer.

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.

char* TAO_Asynch_Queued_Message::buffer_ [private]

The buffer containing the complete message.

ACE_Time_Value TAO_Asynch_Queued_Message::abs_timeout_ [private]


The documentation for this class was generated from the following files:
Generated on Fri Dec 14 03:43:18 2007 for TAO by  doxygen 1.5.3-6