TAO/orbsvcs/examples/CosEC/Factory/CosEventChannelFactory.idl

   1
   2 //=============================================================================
   3 /**
   4  *  @file    CosEventChannelFactory.idl
   5  *
   6  *  @author Pradeep Gore <pradeep@cs.wustl.edu>
   7  */
   8 //=============================================================================
   9
  10
  11 #ifndef TAO_COSEVENTCHANNELFACTORY_IDL
  12 #define TAO_COSEVENTCHANNELFACTORY_IDL
  13
  14 #include "orbsvcs/CosEventChannelAdmin.idl"
  15
  16 module CosEventChannelFactory
  17 {
  18   // = TITLE
  19   //   Module that describes the Channel Factory.
  20   //
  21   exception DuplicateChannel
  22   {
  23     // = TITLE
  24     //    This exception is raised to indicate that a specified
  25     //    channel already exists.
  26   };
  27
  28   exception NoSuchChannel
  29   {
  30     // = TITLE
  31     //   This exception is raised to indicate that a specified
  32     //   channel does not exist.
  33   };
  34
  35   exception BindFailed
  36   {
  37     // = TITLE
  38     //    This exception is raised to indicate that the EventChannel
  39     //    could not be registered with the naming service.
  40   };
  41
  42   interface ChannelFactory
  43   {
  44     // = TITLE
  45     //   Interface definition of the ChannelFactory.
  46     //
  47     // = DESCRIPTION
  48     //   The ChannelFactory is used to create,destroy and
  49     //   locate CosEventChannels.
  50
  51     CosEventChannelAdmin::EventChannel create (
  52       in string channel_id,
  53       in boolean store_in_naming_service) raises (DuplicateChannel, BindFailed);
  54     // Creates a CosEventChannel given a channel id.
  55     // The DuplicateChannel exception is raised if the channel
  56     // already exists.
  57     // BindFailed is raised if we failed to register the newly created channel
  58     // with the naming service.
  59
  60     void destroy (
  61        in string channel_id,
  62        in boolean unbind_from_naming_service) raises (NoSuchChannel);
  63     // Destroys the channel specified by the channel id.
  64     // If the channel does not exist then the NoSuchChannel exception
  65     // is raised.
  66
  67     CosEventChannelAdmin::EventChannel find (
  68        in string channel_id) raises (NoSuchChannel);
  69     // Finds an EventChannel given the channel id.
  70     // If the channel does not exist then the NoSuchChannel exception
  71     // is raised.
  72
  73     string find_channel_id (
  74        in CosEventChannelAdmin::EventChannel channel) raises (NoSuchChannel);
  75    // Returns a channel id given a reference to it.
  76    // If the channel does not exist then the NoSuchChannel exception
  77    // is raised.
  78   };
  79 };
  80
  81 #endif /* TAO_COSEVENTCHANNELFACTORY_IDL */