// -*- C++ -*- // // =================================================================== /** * @file GIOP_Message_Base.h * * $Id$ * * @author Initially Copyrighted by Sun Microsystems Inc., 1994-1995, * @author modified by Balachandran Natarajan */ // =================================================================== #ifndef TAO_GIOP_MESSAGE_BASE_H #define TAO_GIOP_MESSAGE_BASE_H #include "ace/pre.h" #include "tao/Pluggable_Messaging.h" #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ #include "tao/GIOP_Message_Generator_Parser_Impl.h" #include "tao/GIOP_Utils.h" #include "tao/GIOP_Message_State.h" class TAO_Pluggable_Reply_Params; class TAO_Queued_Data; /** * @class TAO_GIOP_Message_Base * * @brief Definitions of the GIOP specific stuff. * * This class will hold the specific details common to all the GIOP * versions. Some of them which are here may be shifted if things * start changing between versions. This class uses the * TAO_GIOP_Message_Reactive_Handler to read and parse messages. */ class TAO_Export TAO_GIOP_Message_Base : public TAO_Pluggable_Messaging { public: // friend class TAO_GIOP_Message_Reactive_Handler; /// Constructor TAO_GIOP_Message_Base (TAO_ORB_Core *orb_core, size_t input_cdr_size = ACE_CDR::DEFAULT_BUFSIZE); /// Dtor virtual ~TAO_GIOP_Message_Base (void); /// Initialize the underlying state object based on the and /// revision numbers virtual void init (CORBA::Octet major, CORBA::Octet minor); /// Reset the messaging the object virtual void reset (void); /// Write the RequestHeader in to the 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); /// Write the RequestHeader in to the stream. virtual int generate_locate_request_header ( TAO_Operation_Details &op, TAO_Target_Specification &spec, TAO_OutputCDR &cdr ); /// Write the reply header virtual int generate_reply_header ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params_Base ¶ms ); /// 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 is /// 1, then reply is read in a blocking manner. virtual int read_message (TAO_Transport *transport, int block = 0, ACE_Time_Value *max_wait_time = 0); /// Format the message. As we have not written the message length in /// the header, we make use of this oppurtunity to insert and format /// the message. virtual int format_message (TAO_OutputCDR &cdr); /// Parse the incoming messages.. virtual int parse_incoming_messages (ACE_Message_Block &message_block); /// Calculate the amount of data that is missing in the /// message block. virtual ssize_t missing_data (ACE_Message_Block &message_block); /* Extract the details of the next message from the * through . Returns 1 if there are more messages and returns a * 0 if there are no more messages in . */ virtual int extract_next_message (ACE_Message_Block &incoming, TAO_Queued_Data *&qd); /// Check whether the node needs consolidation from virtual int consolidate_node (TAO_Queued_Data *qd, ACE_Message_Block &incoming); /// Get the details of the message parsed through the . virtual void get_message_data (TAO_Queued_Data *qd); /// @@Bala:Docu?? virtual int consolidate_fragments (TAO_Queued_Data *dqd, const TAO_Queued_Data *sqd); /// Process the request message that we have received on the /// connection virtual int process_request_message (TAO_Transport *transport, TAO_Queued_Data *qd); /// Parse the reply message that we received and return the reply /// information though virtual int process_reply_message ( TAO_Pluggable_Reply_Params &reply_info, TAO_Queued_Data *qd); /// Generate a reply message with the exception . virtual int generate_exception_reply ( TAO_OutputCDR &cdr, TAO_Pluggable_Reply_Params_Base ¶ms, CORBA::Exception &x ); protected: /// Processes the messages int process_request (TAO_Transport *transport, TAO_InputCDR &input, TAO_OutputCDR &output); /// Processes the messages int process_locate_request (TAO_Transport *transport, TAO_InputCDR &input, TAO_OutputCDR &output); /// Set the state void set_state (CORBA::Octet major, CORBA::Octet minor); /// Print out a debug messages.. void dump_msg (const char *label, const u_char *ptr, size_t len); /// Get the message type. The return value would be one of the /// following: /// TAO_PLUGGABLE_MESSAGE_REQUEST, /// TAO_PLUGGABLE_MESSAGE_REPLY, /// TAO_PLUGGABLE_MESSAGE_CLOSECONNECTION, /// TAO_PLUGGABLE_MESSAGE_MESSAGE_ERROR. TAO_Pluggable_Message_Type message_type (TAO_GIOP_Message_State &state); private: /// Writes the GIOP header in to /// NOTE: If the GIOP header happens to change in the future, we can /// push this method in to the generator_parser classes. int write_protocol_header (TAO_GIOP_Message_Type t, TAO_OutputCDR &msg); /// Make a and hand that over to the transport so /// that it can be sent over the connection. /// NOTE:As on date 1.1 & 1.2 seem to have similar headers. Till an /// unmanageable difference comes let them be implemented here. int make_send_locate_reply (TAO_Transport *transport, TAO_GIOP_Locate_Request_Header &request, TAO_GIOP_Locate_Status_Msg &status, TAO_OutputCDR &output); /// Send error messages int send_error (TAO_Transport *transport); /// Close a connection, first sending GIOP::CloseConnection. void send_close_connection (const TAO_GIOP_Message_Version &version, TAO_Transport *transport, void *ctx); /// We must send a LocateReply through , this request /// resulted in some kind of exception. int send_reply_exception (TAO_Transport *transport, TAO_ORB_Core* orb_core, CORBA::ULong request_id, IOP::ServiceContextList *svc_info, CORBA::Exception *x); /// Write the locate reply header virtual int generate_locate_reply_header ( TAO_OutputCDR & /*cdr*/, TAO_Pluggable_Reply_Params_Base & /*params*/); /// Is the messaging object ready for processing BiDirectional /// request/response? virtual int is_ready_for_bidirectional (void); /// Creates a new node for the queue with a message block in the /// node of size .. TAO_Queued_Data *make_queued_data (size_t sz); private: /// Cached ORB_Core pointer... TAO_ORB_Core *orb_core_; /// Thr message handler object that does reading and parsing of the /// incoming messages TAO_GIOP_Message_State message_state_; /// All the implementations of GIOP message generator and parsers TAO_GIOP_Message_Generator_Parser_Impl tao_giop_impl_; protected: /// The generator and parser state. TAO_GIOP_Message_Generator_Parser *generator_parser_; }; #if defined (__ACE_INLINE__) # include "tao/GIOP_Message_Base.i" #endif /* __ACE_INLINE__ */ #include "ace/post.h" #endif /*TAO_GIOP_MESSAGE_BASE_H*/