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
virtual int all_data_sent (void) const
virtual void fill_iov (int iovcnt_max, int &iovcnt, iovec iov[]) const
virtual void bytes_transferred (size_t &byte_count)
virtual TAO_Queued_Messageclone (ACE_Allocator *alloc)
virtual void destroy (void)
virtual bool is_expired (const ACE_Time_Value &now) const
virtual void copy_if_necessary (const ACE_Message_Block *chain)

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 Member Functions

void operator= (const TAO_Asynch_Queued_Message &)
 TAO_Asynch_Queued_Message (const TAO_Asynch_Queued_Message &)

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_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.

TAO_Asynch_Queued_Message::TAO_Asynch_Queued_Message ( const TAO_Asynch_Queued_Message  )  [private]


Member Function Documentation

int TAO_Asynch_Queued_Message::all_data_sent ( void   )  const [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::bytes_transferred ( size_t &  byte_count  )  [virtual]

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

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::copy_if_necessary ( const ACE_Message_Block chain  )  [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]

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::fill_iov ( int  iovcnt_max,
int &  iovcnt,
iovec  iov[] 
) const [virtual]

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

Implements TAO_Queued_Message.

bool TAO_Asynch_Queued_Message::is_expired ( const ACE_Time_Value now  )  const [virtual]

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

Reimplemented from TAO_Queued_Message.

size_t TAO_Asynch_Queued_Message::message_length ( void   )  const [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::operator= ( const TAO_Asynch_Queued_Message  )  [private]


Member Data Documentation

The buffer containing the complete message.

The offset in the buffer.

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

size_t const TAO_Asynch_Queued_Message::size_ [private]

The number of bytes in the buffer.


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

Generated on Mon Jul 13 16:25:34 2009 for TAO by  doxygen 1.5.8