TAO/tao/Utils/Encodable.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    Encodable.h
   6  *
   7  *   Defines the interface for classes that wish to be
   8  *   encodable/decodable into/from a CDR representation.
   9  *
  10  *  @author  Angelo Corsaro <corsaro@cs.wustl.edu>
  11  */
  12 //=============================================================================
  13
  14 #ifndef TAO_ENCODABLE_H_
  15 #define TAO_ENCODABLE_H_
  16
  17 #include /**/ "ace/pre.h"
  18
  19 #include "tao/Basic_Types.h"
  20
  21 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  22 # pragma once
  23 #endif /* ACE_LACKS_PRAGMA_ONCE */
  24
  25 #include "tao/Utils/utils_export.h"
  26
  27 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 class TAO_OutputCDR;
  30 class TAO_InputCDR;
  31
  32 /**
  33  * @class TAO_Encodable
  34  *
  35  * @brief TAO_Encodable Interface
  36  *
  37  * This interface should be inherited by classes that wish to be
  38  * encoded/decoded into/from a CDR stream. Implementation of the
  39  * streaming methods is deferred to the subclasses.
  40  */
  41 class TAO_UTILS_Export TAO_Encodable
  42 {
  43 public:
  44   virtual ~TAO_Encodable ();
  45
  46   ///  Encodes the object implementing this method into a CDR stream.
  47   ///  Returns true on success and false on failure.
  48   virtual CORBA::Boolean _tao_encode (TAO_OutputCDR &out_cdr) = 0;
  49
  50   ///  Decodes the object implementing this method from a CDR stream.
  51   ///  Returns true on success and false on failure.
  52   virtual CORBA::Boolean _tao_decode (TAO_InputCDR &in_cdr) = 0;
  53 };
  54
  55 TAO_END_VERSIONED_NAMESPACE_DECL
  56
  57 #include /**/ "ace/post.h"
  58
  59 #endif /* TAO_ENCODABLE_H_ */