---

TAO_Pluggable_Messaging Class Reference

Generic definitions Messaging class. More...

#include <Pluggable_Messaging.h>

Inheritance diagram for TAO_Pluggable_Messaging:

[legend]List of all members.

Public Methods
virtual	~TAO_Pluggable_Messaging (void)
	Dtor.
virtual int	generate_request_header (TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr)=0
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.
virtual int	generate_reply_header (TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params_Base &params)=0
virtual int	generate_locate_reply_header (TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params_Base &params)=0
virtual int	read_message (TAO_Transport *transport, int block=0, ACE_Time_Value *max_wait_time=0)=0
virtual int	format_message (TAO_OutputCDR &cdr)=0
virtual void	init (CORBA::Octet major, CORBA::Octet minor)=0
	Do any initialisations that may be needed.
virtual int	parse_incoming_messages (ACE_Message_Block &message_block)=0
	Parse the incoming messages..
virtual ssize_t	missing_data (ACE_Message_Block &incoming)=0
virtual void	get_message_data (TAO_Queued_Data *qd)=0
	Get the details of the message parsed through the <qd>.
virtual int	extract_next_message (ACE_Message_Block &incoming, TAO_Queued_Data *&qd)=0
virtual int	consolidate_node (TAO_Queued_Data *qd, ACE_Message_Block &incoming)=0
	Check whether the node <qd> needs consolidation from <incoming>.
virtual int	consolidate_fragments (TAO_Queued_Data *dqd, const TAO_Queued_Data *sqd)=0
	Bala:Docu??
virtual int	process_request_message (TAO_Transport *transport, TAO_Queued_Data *qd)=0
virtual int	process_reply_message (TAO_Pluggable_Reply_Params &reply_info, TAO_Queued_Data *qd)=0
virtual int	generate_exception_reply (TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params_Base &params, CORBA::Exception &x)=0
	Generate a reply message with the exception <ex>.
virtual int	is_ready_for_bidirectional (TAO_OutputCDR &msg)=0
virtual void	reset (void)=0
	Reset the messaging the object.
virtual size_t	header_length (void) const=0
	Header length.
virtual TAO_OutputCDR &	out_stream (void)=0
	Accessor for the output CDR stream.

---

Detailed Description

Generic definitions Messaging class.

This interface tries to define generic methods that could be different messaging protocols

---

Constructor & Destructor Documentation

TAO_Pluggable_Messaging::~TAO_Pluggable_Messaging (  void    )  [virtual]

Dtor.

---

Member Function Documentation

virtual int TAO_Pluggable_Messaging::consolidate_fragments (  TAO_Queued_Data *    dqd, const TAO_Queued_Data *    sqd )  [pure virtual]

Bala:Docu?? @ Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::consolidate_node (  TAO_Queued_Data *    qd, ACE_Message_Block &    incoming )  [pure virtual]

Check whether the node <qd> needs consolidation from <incoming>. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::extract_next_message (  ACE_Message_Block &    incoming, TAO_Queued_Data *&    qd )  [pure virtual]

Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::format_message (  TAO_OutputCDR &    cdr )  [pure virtual]

Format the message in the <cdr>. May not be needed in general. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::generate_exception_reply (  TAO_OutputCDR &    cdr, TAO_Pluggable_Reply_Params_Base &    params, CORBA::Exception &    x )  [pure virtual]

Generate a reply message with the exception <ex>. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::generate_locate_reply_header (  TAO_OutputCDR &    cdr, TAO_Pluggable_Reply_Params_Base &    params )  [pure virtual]

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. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::generate_locate_request_header (  TAO_Operation_Details &    op, TAO_Target_Specification &    spec, TAO_OutputCDR &    cdr )  [pure virtual]

Write the RequestHeader in to the <cdr> stream. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::generate_reply_header (  TAO_OutputCDR &    cdr, TAO_Pluggable_Reply_Params_Base &    params )  [pure virtual]

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. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::generate_request_header (  TAO_Operation_Details &    op, TAO_Target_Specification &    spec, TAO_OutputCDR &    cdr )  [pure virtual]

Write the RequestHeader in to the <cdr> stream. The underlying implementation of the mesaging should do the right thing. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual void TAO_Pluggable_Messaging::get_message_data (  TAO_Queued_Data *    qd )  [pure virtual]

Get the details of the message parsed through the <qd>. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual size_t TAO_Pluggable_Messaging::header_length (  void    )  const [pure virtual]

Header length. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual void TAO_Pluggable_Messaging::init (  CORBA::Octet    major, CORBA::Octet    minor )  [pure virtual]

Do any initialisations that may be needed. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::is_ready_for_bidirectional (  TAO_OutputCDR &    msg )  [pure virtual]

Is the messaging object ready for processing BiDirectional request/response? Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual ssize_t TAO_Pluggable_Messaging::missing_data (  ACE_Message_Block &    incoming )  [pure virtual]

Calculate the amount of data that is missing in the <incoming> message block. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual TAO_OutputCDR& TAO_Pluggable_Messaging::out_stream (  void    )  [pure virtual]

Accessor for the output CDR stream. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::parse_incoming_messages (  ACE_Message_Block &    message_block )  [pure virtual]

Parse the incoming messages.. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::process_reply_message (  TAO_Pluggable_Reply_Params &    reply_info, TAO_Queued_Data *    qd )  [pure virtual]

Parse the reply message that we received and return the reply information though <reply_info> Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::process_request_message (  TAO_Transport *    transport, TAO_Queued_Data *    qd )  [pure virtual]

Parse the request message, make an upcall and send the reply back to the "request initiator" Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual int TAO_Pluggable_Messaging::read_message (  TAO_Transport *    transport, int    block = 0, ACE_Time_Value *    max_wait_time = 0 )  [pure virtual]

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. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

virtual void TAO_Pluggable_Messaging::reset (  void    )  [pure virtual]

Reset the messaging the object. Implemented in TAO_GIOP_Message_Base, and TAO_GIOP_Message_Lite.

---

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

• Pluggable_Messaging.h
• Pluggable_Messaging.cpp

---