it_bus_pdk/message_context.h

#ifndef _IT_BUS_PDK_MESSAGE_CONTEXT_H_
#define _IT_BUS_PDK_MESSAGE_CONTEXT_H_

// @Copyright 2005 IONA Technologies, Plc. All Rights Reserved.
//

#include <it_bus/api_defines.h>

namespace IT_WSDL
{
    class WSDLOperation;
    class WSDLPort;
}

namespace IT_Bus
{
    class TransportWritableMessage;
    class MessageReader;
    class MessageWriter;
    class ContextContainer;
    class DispatchInfo;
    class BinaryBuffer;
 
    /*
     * The following interface represents an outgoing message that's passed
     * on to an Endpoint in a call to invoke() or send_message().
     * It also holds all the necessary context information required.
     */ 
    class IT_BUS_API SendMessageContext
    {
      public:

        virtual void
        recycle() = 0;

        /*
         * The passthru attribute is used to notify the underlying
         * endpoint to *passthru* the message with the assumption
         * that the message has already been marshalled to a
         * BinaryBuffer and that no further processing is required.
         * So, an implementation of Endpoint::send_message() will
         * query for the passthru flag via call to is_passthru_enabled().
         * If set, it would simply call the underlying Endpoint::send_message().
         * An implementation of Endpoint::invoke() will
         * query for the passthru flag via call to is_passthru_enabled().
         * If set, it would simply call the underlying Endpoint::invoke().
         */
        virtual bool
        is_passthru_enabled() = 0;

        virtual IT_WSDL::WSDLOperation&
        get_wsdl_operation() = 0;

        virtual TransportWritableMessage*
        get_writable_message() = 0;

        virtual MessageWriter*
        get_message_writer() = 0;

        virtual ContextContainer*
        get_context_container() = 0;

        virtual void
        set_data(
            BinaryBuffer*,
            bool take_ownership = false
        ) = 0;

        virtual BinaryBuffer*
        get_data(
            bool relinquish_ownership = false
        ) = 0;

        virtual DispatchInfo*
        get_dispatch_context() = 0;

        virtual bool
        is_request() = 0;

        virtual void
        set_wsdl_port(
            const IT_WSDL::WSDLPort*
        ) = 0;

        virtual const IT_WSDL::WSDLPort*
        get_wsdl_port() = 0;
    };

    /*
     * The following interface represents an incoming message that's passed
     * on to an EndpointHandler in a call to message_received() or is an output
     * parameter in a call to SyncEndpoint::invoke(). It also holds all the
     * necessary context information required.
     */ 
    class IT_BUS_API ReceiveMessageContext
    {
      public:

        virtual void
        recycle() = 0;

        virtual MessageReader*
        get_message_reader() = 0;

        virtual ContextContainer*
        get_context_container() = 0;

        virtual void
        set_data(
            BinaryBuffer*,
            bool take_ownership = false
        ) = 0;

        virtual BinaryBuffer*
        get_data(
            bool relinquish_ownership = false
        ) = 0;

        virtual DispatchInfo*
        get_dispatch_context() = 0;

        /*
         * On server-side, ReceiveMessageContext is associated with
         * an instance of DispatchInfo, so that it's used when the response
         * is sent synchronously. But if the response is going to be
         * asynchronous (sent on a wsa:ReplyTo endpoint or wsrm:AcksTo endpoint),
         * then the lifecycles of ReceiveMessageContext and DispatchInfo are
         * going to be different, so the following API is used to decouple
         * the DispatchInfo from the ReceiveMessageContext.
         */
        virtual void
        decouple_dispatch_context() = 0;
    };
}

#endif  

---