/* Network-Integrated Multimedia Middleware (NMM)
 * http://www.motama.com/nmm.html
 *
 * Copyright (C) 2006-2007
 * Motama GmbH, Saarbruecken, Germany
 * http://www.motama.com
 *
 * This file is part of NMM. 
 * 
 * NMM is free software; you can redistribute it and/or modify it    
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; only version 2 of the License.      
 * 
 * NMM is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public 
 * License for more details.  
 * 
 * You should have received a copy of the GNU General Public License 
 * along with NMM; if not, write to the Free Software Foundation,    
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 */

#include "ICompositeStrategy.idl"

module NMM {
  
  /** Out-of-band composite transport strategy.
   * This is an interface for the %OutOfBandCompositeStrategy. It provides access to child transport strategies and
   * the request/reply unit. It also defines internal configuration events.
   */
  interface IOutOfBandCompositeStrategy : ICompositeStrategy {
    /** Transport roles.
     */
    enum TransportRole {
      RECEIVE_ONE_WAY_EVENT_REQUEST = 1,  ///< Receive one-way event request
      RECEIVE_ONE_WAY_EVENT_REPLY   = 2,  ///< Receive one-way event reply
      SEND_ONE_WAY_EVENT_REQUEST    = 4,  ///< Send one-way event request
      SEND_ONE_WAY_EVENT_REPLY      = 8,  ///< Send one-way event reply
      RECEIVE_REQUEST_REPLY_EVENT   = 16, ///< Receive request-reply event
      SEND_REQUEST_REPLY_EVENT      = 32  ///< Send request-reply event
    };
    
    /** Returns child strategy for receiving one-way %Event requests.
     * If this method returns 0, then the binding is realized by a request-reply
     * leaf strategy, which is returned by getRequestReplyEventReceiverStrategy().
     *
     * @return Interface to child strategy for receiving one-way %Event requests.
     */
    ITransportStrategy* getOneWayEventRequestReceiverStrategy() const;
    
    /** Returns child strategy for receiving one-way %Event replies.
     * If this method returns 0, then the binding is realized by a request-reply
     * leaf strategy, which is returned by getRequestReplyEventSenderStrategy().
     *
     * @return Interface to child strategy for receiving one-way %Event replies.
     */
    ITransportStrategy* getOneWayEventReplyReceiverStrategy() const;
    
    /** Returns child strategy for sending one-way %Event requests.
     * If this method returns 0, then the binding is realized by a request-reply
     * leaf strategy, which is returned by getRequestReplyEventReceiverStrategy().
     *
     * @return Interface to child strategy for sending one-way %Event requests.
     */
    ITransportStrategy* getOneWayEventRequestSenderStrategy() const;
    
    /** Returns child strategy for sending one-way %Event replies.
     * If this method returns 0, then the binding is realized by a request-reply
     * leaf strategy, which is returned by getRequestReplyEventSenderStrategy().
     *
     * @return Interface to child strategy for sending one-way %Event replies.
     */
    ITransportStrategy* getOneWayEventReplySenderStrategy() const;
    
    /** Returns child strategy for receiving request-reply Events.
     * If this method returns 0, then the binding is realized by two one-way
     * leaf strategies, which are returned by getOneWayEventRequestReceiverStrategy()
     * and getOneWayEventReplySenderStrategy().
     *
     * @return Interface to child strategy for receiving request-reply Events
     */
    ITransportStrategy* getRequestReplyEventReceiverStrategy() const;
    
    /** Returns child strategy for sending request-reply Events.
     * If this method returns 0, then the binding is realized by two one-way
     * leaf strategies, which are returned by getOneWayEventRequestSenderStrategy()
     * and getOneWayEventReplyReceiverStrategy().
     *
     * @return Interface to child strategy for sending request-reply Events
     */
    ITransportStrategy* getRequestReplyEventSenderStrategy() const;
  };
  
}
