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

#ifndef QPID_CLIENT_SUBSCRIPTIONIMPL_H
#define QPID_CLIENT_SUBSCRIPTIONIMPL_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.
 *
 */

#include "qpid/client/SubscriptionSettings.h"
#include "qpid/client/Session.h"
#include "qpid/client/MessageListener.h"
#include "qpid/framing/enum.h"
#include "qpid/framing/SequenceSet.h"
#include "qpid/sys/Mutex.h"
#include "qpid/RefCounted.h"

namespace qpid {
namespace client {

class SubscriptionManager;

class SubscriptionImpl : public RefCounted, public MessageListener {
  public:
    SubscriptionImpl(SubscriptionManager&, const std::string& queue,
                     const SubscriptionSettings&, const std::string& name, MessageListener* =0);
    
    /** The name of the subsctription, used as the "destination" for messages from the broker.
     * Usually the same as the queue name but can be set differently.
     */
    std::string getName() const;

    /** Name of the queue this subscription subscribes to */
    std::string getQueue() const;

    /** Get the flow control and acknowledgement settings for this subscription */
    const SubscriptionSettings& getSettings() const;

    /** Set the flow control parameters */
    void setFlowControl(const FlowControl&);

    /** Automatically acknowledge (acquire and accept) batches of n messages.
     * You can disable auto-acknowledgement by setting n=0, and use acquire() and accept()
     * to manually acquire and accept messages.
     */
    void setAutoAck(size_t n);

    /** Get the set of ID's for messages received by this subscription but not yet acquired.
     * This will always be empty if  acquireMode=ACQUIRE_MODE_PRE_ACQUIRED
     */
    SequenceSet getUnacquired() const;

    /** Get the set of ID's for messages acquired by this subscription but not yet accepted. */
    SequenceSet getUnaccepted() const;

    /** Acquire messageIds and remove them from the un-acquired set for the session. */
    void acquire(const SequenceSet& messageIds);

    /** Accept messageIds and remove them from the un-accepted set for the session. */
    void accept(const SequenceSet& messageIds);

    /** Release messageIds and remove them from the un-accepted set for the session. */
    void release(const SequenceSet& messageIds);

    /** Get the session associated with this subscription */
    Session getSession() const;

    /** Get the subscription manager associated with this subscription */
    SubscriptionManager& getSubscriptionManager() const;

    /** Send subscription request and issue appropriate flow control commands. */
    void subscribe();

    /** Cancel the subscription. */
    void cancel();

    /** Grant specified credit for this subscription **/
    void grantCredit(framing::message::CreditUnit unit, uint32_t value);

    void received(Message&);
    
  private:

    mutable sys::Mutex lock;
    SubscriptionManager& manager;
    std::string name, queue;
    SubscriptionSettings settings;
    framing::SequenceSet unacquired, unaccepted;
    MessageListener* listener;
};

}} // namespace qpid::client

#endif  /*!QPID_CLIENT_SUBSCRIPTIONIMPL_H*/