TAO/examples/Content_Server/SMI_Iterator/Web_Server.idl

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