TAO/examples/Content_Server/AMI_Iterator/Web_Server.idl

   1 module Web_Server
   2 // = TITLE
   3 // IDL schema definition for Web server interface.
   4 {
   5   typedef sequence<octet> Chunk_Type;
   6
   7   interface Content_Iterator
   8   {
   9     // This operation returns the next <chunk> of the
  10     // file starting at <offset>.  If there are
  11     // no more bindings, false is returned.
  12     boolean next_chunk (in unsigned long long offset,
  13                         out Chunk_Type chunk);
  14
  15     // This operation destroys the iterator.
  16     void destroy ();
  17   };
  18
  19   exception Error_Result {
  20     // Status of the <get_iterator> operation.  These
  21     // values should map onto the normal HTTP
  22     // status values, e.g., 200 means success, 404
  23     // means "file not found," etc.
  24     short status;
  25  };
  26
  27   struct Metadata_Type
  28   {
  29     // Modification date.
  30     string modification_date;
  31
  32     // Type of content.
  33     string content_type;
  34   };
  35
  36   interface Iterator_Factory
  37   {
  38     // This factory method returns a <Content_Iterator> that
  39     // can be used to read the <contents> associated with
  40     // <pathname> one ``chunk'' at a time.  The <metadata>
  41     // reports information about the <contents>.
  42     void get_iterator (in string pathname,
  43                        out Content_Iterator contents,
  44                        out Metadata_Type metadata)
  45       raises (Error_Result);
  46   };
  47 };