TAO/tao/IOR_Parser.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file   IOR_Parser.h
   6  *
   7  *  @author Carlos O'Ryan (coryan@cs.wustl.edu)
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef TAO_IOR_PARSER_H
  13 #define TAO_IOR_PARSER_H
  14
  15 #include /**/ "ace/pre.h"
  16 #include "ace/Service_Object.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "tao/orbconf.h"
  23 #include "tao/TAO_Export.h"
  24
  25 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  26
  27 namespace CORBA
  28 {
  29   class Object;
  30   typedef Object *Object_ptr;
  31
  32   class ORB;
  33   typedef ORB *ORB_ptr;
  34 }
  35
  36 /**
  37  * @class TAO_IOR_Parser
  38  *
  39  * @brief Defines the interface for the pluggable IOR parser components
  40  *
  41  * The ORB is able to dynamically load the list of IOR formats it
  42  * understands.  That allow us to integrate formats such as
  43  * corbaname:, http: or ftp: only when required.
  44  * This class provides a uniform interface for all the IOR parsers
  45  */
  46 class TAO_Export TAO_IOR_Parser : public ACE_Service_Object
  47 {
  48 public:
  49   /// The destructor
  50   TAO_IOR_Parser () = default;
  51   virtual ~TAO_IOR_Parser ();
  52
  53   /// Return true if @a ior_string starts with a prefix known to this IOR
  54   /// parser
  55   virtual bool match_prefix (const char *ior_string) const = 0;
  56
  57   /**
  58    * Parse the @a ior argument and return an object reference.
  59    * The call may raise the standard system exceptions (NO_MEMORY,
  60    * INV_OBJREF, etc.)
  61    */
  62   virtual CORBA::Object_ptr parse_string (const char *ior, CORBA::ORB_ptr orb) = 0;
  63 };
  64
  65 TAO_END_VERSIONED_NAMESPACE_DECL
  66
  67 #include /**/ "ace/post.h"
  68 #endif /* TAO_IOR_PARSER_H */