// -*- C++ -*-
// $Id$

// ============================================================================
//
// = LIBRARY
//     TAO
//
// = FILENAME
//     GIOP_Message_Connectors.h
//
// = DESCRIPTION
//   Interface for the client side of the GIOP classes  
//
// = AUTHOR
//     Balachandran Natarajan <bala@cs.wustl.edu>
//
// ============================================================================

// @@ Bala: Please be consisten about the macros, if you are not,
// somebody will use the same one in another file, it is hard to find
// them and change them automatically, etc. etc.
#ifndef TAO_GIOP_MESSAGE_CONNECTORS_
#define TAO_GIOP_MESSAGE_CONNECTORS_
#include "tao/GIOP_Message_Base.h"

class TAO_Export TAO_GIOP_Message_Connectors:
  public TAO_GIOP_Message_Base
{
  // = TITLE
  //   TAO_GIOP_Message_Connectors
  // = DESCRIPTION
  //   This class provides methods and code for the connector specific
  //   functionality of GIOP.The motivation for this class is to hold
  //   common code between different versions of GIOP in a single
  //   class. 
  
protected:
  int parse_reply (TAO_Message_State_Factory &mesg_state,
                   TAO_Pluggable_Connector_Params &params);
  // Parse the reply message from the server

private:
  virtual CORBA::Boolean 
  write_locate_request_header (CORBA::ULong request_id,
                               TAO_Target_Specification &spec,
                               TAO_OutputCDR &msg) = 0;
  // Need not be here. But just for the sake of documentaion.


  int validate_version (TAO_GIOP_Message_State *state);
  
  CORBA::Octet major_version (void) = 0;
  CORBA::Octet minor_version (void) = 0;
  // Virtual methods that will be implemented by the version specific
  // class. There may be a feeling that this declaration may not be
  // required, but some of the code in the class look for this method

   int process_connector_messages (TAO_Transport *transport,
                                  TAO_ORB_Core *orb_core,
                                  TAO_InputCDR &input,
                                  CORBA::Octet message_type);
  // Processes the messages from the connectors so that they can be
  // passed on to the appropriate states.
};

//////////////////////////////////////////////////
// Version specific classes of GIOP
//////////////////////////////////////////////////

class TAO_Export TAO_GIOP_Message_Connector_11:
  public TAO_GIOP_Message_Connectors
{
  // = TITLE
  //   TAO_GIOP_Message_Connector_11
  // = DESCRIPTION
  //   This class provides methods methods that implements the GIOP
  //   (1.1) specific stuff.
public:

private:
  virtual CORBA::Boolean 
  write_request_header (const TAO_Operation_Details &opdetails,
                        TAO_Target_Specification &spec,
                        TAO_OutputCDR &msg);
  // Write the request header in to <msg>

  CORBA::Boolean
  write_locate_request_header (CORBA::ULong request_id,
                               TAO_Target_Specification &spec,
                               TAO_OutputCDR &msg);
  // Write the locate request header in to the <msg>
  
  int parse_reply (TAO_Message_State_Factory &mesg_state,
                   TAO_Pluggable_Connector_Params &params);
  // Parse the reply messages from the server

  CORBA::Octet major_version (void);
  CORBA::Octet minor_version (void);
  // Our minor and major versions
};

// @@ Bala: this is *COMPLETELY* backwards, this way we have to change
// all the classes everytime a new version comes out. We also may want
// to compile TAO with only support for GIOP 1.1 (say because this is
// an embedded application that does not need the cool GIOP 1.1 and
// 1.2 features)!
class TAO_Export TAO_GIOP_Message_Connector_10:
  public TAO_GIOP_Message_Connector_11
{
  // = TITLE
  //   TAO_GIOP_Message_Connector_10
  // = DESCRIPTION
  //   This class is deribed from the 1.1 version of GIOP. At presnt
  //   this only returns the right version number
public:

private:
  CORBA::Octet minor_version (void);
};

#if defined (__ACE_INLINE__)
# include "tao/GIOP_Message_Connectors.i"
#endif /* __ACE_INLINE__ */

#endif /*TAO_GIOP_MESSAGE_CONNECTORS*/