diff options
Diffstat (limited to 'TAO/tao/Pluggable_Messaging.h')
| -rw-r--r-- | TAO/tao/Pluggable_Messaging.h | 103 |
1 files changed, 54 insertions, 49 deletions
diff --git a/TAO/tao/Pluggable_Messaging.h b/TAO/tao/Pluggable_Messaging.h index ee3a71f876e..6e7b19a896a 100644 --- a/TAO/tao/Pluggable_Messaging.h +++ b/TAO/tao/Pluggable_Messaging.h @@ -1,21 +1,18 @@ // -*- C++ -*- -// $Id$ -// ============================================================================ -// -// = LIBRARY -// TAO -// -// = FILENAME -// Pluggable_Messaging.h -// -// = DESCRIPTION -// Interface for the TAO pluggable messaging framework. -// -// = AUTHOR -// Balachandran Natarajan <bala@cs.wustl.edu> -// -// ============================================================================ +//============================================================================= +/** + * @file Pluggable_Messaging.h + * + * $Id$ + * + * Interface for the TAO pluggable messaging framework. + * + * + * @author Balachandran Natarajan <bala@cs.wustl.edu> + */ +//============================================================================= + // #ifndef TAO_PLUGGABLE_MESSAGING_H #define TAO_PLUGGABLE_MESSAGING_H @@ -48,87 +45,95 @@ class TAO_OutputCDR; // I am going to take a closer look on this after my MS defense - // Bala +/** + * @class TAO_Pluggable_Messaging + * + * @brief Generic definitions Messaging class. + * + * This interface tries to define generic methods that could be + * different messaging protocols + */ class TAO_Export TAO_Pluggable_Messaging { - // = TITLE - // Generic definitions Messaging class. - // - // = DESCRIPTION - // This interface tries to define generic methods that could be - // different messaging protocols public: + /// Dtor virtual ~TAO_Pluggable_Messaging (void); - // Dtor + /// Write the RequestHeader in to the <cdr> stream. The underlying + /// implementation of the mesaging should do the right thing. virtual int generate_request_header ( TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr) = 0; - // Write the RequestHeader in to the <cdr> stream. The underlying - // implementation of the mesaging should do the right thing. + /// Write the RequestHeader in to the <cdr> stream. virtual int generate_locate_request_header ( TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr) = 0; - // Write the RequestHeader in to the <cdr> stream. + /** + * Write the reply header + * The reply header is a part of any messaging protocol. The + * messaging protocol implementation would implement the way the + * reply header is written. + */ virtual int generate_reply_header ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms) = 0; - // Write the reply header - // The reply header is a part of any messaging protocol. The - // messaging protocol implementation would implement the way the - // reply header is written. + /** + * Write the locate reply header + * The locate reply header is a part of any messaging protocol. The + * messaging protocol implementation would implement the way the + * locate reply header is written. + */ virtual int generate_locate_reply_header ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms) = 0; - // Write the locate reply header - // The locate reply header is a part of any messaging protocol. The - // messaging protocol implementation would implement the way the - // locate reply header is written. + /** + * This method reads the message on the connection. Returns 0 when + * there is short read on the connection. Returns 1 when the full + * message is read and handled. Returns -1 on errors. If <block> is + * 1, then reply is read in a blocking manner. <bytes> indicates the + * number of bytes that needs to be read from the connection. + */ virtual int read_message (TAO_Transport *transport, int block = 0, ACE_Time_Value *max_wait_time = 0) = 0; - // This method reads the message on the connection. Returns 0 when - // there is short read on the connection. Returns 1 when the full - // message is read and handled. Returns -1 on errors. If <block> is - // 1, then reply is read in a blocking manner. <bytes> indicates the - // number of bytes that needs to be read from the connection. + /// Format the message in the <cdr>. May not be needed in + /// general. virtual int format_message (TAO_OutputCDR &cdr) = 0; - // Format the message in the <cdr>. May not be needed in - // general. + /// Get the message type that was received. virtual TAO_Pluggable_Message_Type message_type (void) = 0; - // Get the message type that was received. + /// Do any initialisations that may be needed. virtual void init (CORBA::Octet major, CORBA::Octet minor) = 0; - // Do any initialisations that may be needed. + /// Reset teh messaging object virtual void reset (int reset_flag = 1) = 0; - // Reset teh messaging object + /// Parse the request message, make an upcall and send the reply back + /// to the "request initiator" virtual int process_request_message (TAO_Transport *transport, TAO_ORB_Core *orb_core) = 0; - // Parse the request message, make an upcall and send the reply back - // to the "request initiator" + /// Parse the reply message that we received and return the reply + /// information though <reply_info> virtual int process_reply_message ( TAO_Pluggable_Reply_Params &reply_info) = 0; - // Parse the reply message that we received and return the reply - // information though <reply_info> + /// Generate a reply message with the exception <ex>. virtual int generate_exception_reply ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params ¶ms, CORBA::Exception &x) = 0; - // Generate a reply message with the exception <ex>. }; #if defined (__ACE_INLINE__) |