// -*- IDL -*-

// ================================================================
/**
 *  @file TAO.pidl
 *
 *  $Id$
 *
 *  This file contains TAO-specific idl interfaces (not part of CORBA
 *  2.6).
 *
 *  The steps to regenerate the code are as follows:
 *
 * 1. Run the tao_idl compiler on the pidl file.  The command used for
 *   this is:
 *
 *   tao_idl
 *       -o orig -Gp -Gd -Ge 1 -GT -GA
 *       -Wb,export_macro=TAO_Export
 *       -Wb,pre_include="ace/pre.h"
 *       -Wb,post_include="ace/post.h"
 *       TAO.pidl
 *
 *   2. Then patch the generated code.  The patch fixes the interface
 *   repository IDs, disables the code under certain configurations,
 *   and eliminates cycles in the include dependencies.
 *
 *   Apply patches using the following commands:
 *
 *   patch < diffs/TAOC.h.diff
 *   patch < diffs/TAOC.i.diff
 *   patch < diffs/TAOC.cpp.diff
 *
 *   @note The diffs were generated with these commands:
 *
 *   * Note: to update the patch file after re-generating the code use:
 *
 *   for i in TAO{C,S,S_T}.{h,i,cpp}; do
 *     diff -uBbw orig/$i $i;
  *   done > diffs/TAO.diff
 */
// ================================================================

#ifndef TAO_TAO_IDL
#define TAO_TAO_IDL

#include "Policy.pidl"
#include "TimeBase.pidl"
#include "Messaging_SyncScope.pidl"

#pragma prefix "tao"

module TAO
{

  //
  // Buffering constraint.
  //
  typedef unsigned short BufferingConstraintMode;
  const BufferingConstraintMode BUFFER_FLUSH         = 0x00;

  // Note that timeout, message_count, and message_bytes can be or'd.
  const BufferingConstraintMode BUFFER_TIMEOUT       = 0x01;
  const BufferingConstraintMode BUFFER_MESSAGE_COUNT = 0x02;
  const BufferingConstraintMode BUFFER_MESSAGE_BYTES = 0x04;

  struct BufferingConstraint
  {
    BufferingConstraintMode mode;
    TimeBase::TimeT timeout;
    unsigned long message_count;
    unsigned long message_bytes;
  };

  const CORBA::PolicyType BUFFERING_CONSTRAINT_POLICY_TYPE = 0x54410001;

  local interface BufferingConstraintPolicy : CORBA::Policy
    {
      readonly attribute BufferingConstraint buffering_constraint;
    };

  // = TAO specific.
  const Messaging::SyncScope SYNC_EAGER_BUFFERING   = Messaging::SYNC_NONE;
  const Messaging::SyncScope SYNC_DELAYED_BUFFERING = -2;

};

#pragma prefix ""

#endif /* TAO_TAO_IDL */