RC9/qpid/cpp/src/qpid/client/Future.h

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

#ifndef _Future_
#define _Future_

#include <boost/bind.hpp>
#include <boost/shared_ptr.hpp>
#include "qpid/Exception.h"
#include "qpid/framing/SequenceNumber.h"
#include "qpid/framing/StructHelper.h"
#include "FutureCompletion.h"
#include "FutureResult.h"
#include "SessionImpl.h"

namespace qpid {
namespace client {

/**@internal */
class Future : private framing::StructHelper
{
    framing::SequenceNumber command;
    boost::shared_ptr<FutureResult> result;
    bool complete;

public:
    Future() : complete(false) {}    
    Future(const framing::SequenceNumber& id) : command(id), complete(false) {}    

    template <class T> void decodeResult(T& value, SessionImpl& session) 
    {
        if (result) {
            decode(value, result->getResult(session));
        } else {
            throw Exception("Result not expected");
        }
    }

    void wait(SessionImpl& session);
    bool isComplete(SessionImpl& session);
    void setFutureResult(boost::shared_ptr<FutureResult> r);
};

}}

#endif