qpid/client/SubscriptionManager.h

Go to the documentation of this file.

#ifndef QPID_CLIENT_SUBSCRIPTIONMANAGER_H
#define QPID_CLIENT_SUBSCRIPTIONMANAGER_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/Session.h"
#include "qpid/client/Subscription.h"
#include "qpid/sys/Runnable.h"
#include "qpid/sys/Thread.h"
#include "qpid/client/ClientImportExport.h"
#include "qpid/client/MessageListener.h"
#include "qpid/client/LocalQueue.h"
#include "qpid/client/Handle.h"
#include <string>

namespace qpid {
namespace client {

class SubscriptionManagerImpl;

class QPID_CLIENT_CLASS_EXTERN SubscriptionManager : public sys::Runnable, public Handle<SubscriptionManagerImpl>
{
  public:
    QPID_CLIENT_EXTERN SubscriptionManager(const Session& session);
    QPID_CLIENT_EXTERN SubscriptionManager(const SubscriptionManager&);
    QPID_CLIENT_EXTERN ~SubscriptionManager();
    QPID_CLIENT_EXTERN SubscriptionManager& operator=(const SubscriptionManager&);

    QPID_CLIENT_EXTERN Subscription subscribe(MessageListener& listener,
                           const std::string& queue,
                           const SubscriptionSettings& settings,
                           const std::string& name=std::string());

    QPID_CLIENT_EXTERN Subscription subscribe(LocalQueue& localQueue,
                           const std::string& queue,
                           const SubscriptionSettings& settings,
                           const std::string& name=std::string());

    QPID_CLIENT_EXTERN Subscription subscribe(MessageListener& listener,
                           const std::string& queue,
                           const std::string& name=std::string());

    QPID_CLIENT_EXTERN Subscription subscribe(LocalQueue& localQueue,
                           const std::string& queue,
                           const std::string& name=std::string());


    QPID_CLIENT_EXTERN bool get(Message& result, const std::string& queue, sys::Duration timeout=0);

    QPID_CLIENT_EXTERN Message get(const std::string& queue, sys::Duration timeout=sys::TIME_INFINITE);

    QPID_CLIENT_EXTERN Subscription getSubscription(const std::string& name) const;

    QPID_CLIENT_EXTERN void cancel(const std::string& name);

    QPID_CLIENT_EXTERN void run();

    QPID_CLIENT_EXTERN void start();

    QPID_CLIENT_EXTERN void wait();

    QPID_CLIENT_EXTERN void setAutoStop(bool set=true);

    QPID_CLIENT_EXTERN void stop();

    static const uint32_t UNLIMITED=0xFFFFFFFF;

    QPID_CLIENT_EXTERN void setFlowControl(const std::string& name, const FlowControl& flow);

    QPID_CLIENT_EXTERN void setFlowControl(const std::string& name, uint32_t messages,  uint32_t bytes, bool window=true);

    QPID_CLIENT_EXTERN void setDefaultSettings(const SubscriptionSettings& s);

    QPID_CLIENT_EXTERN const SubscriptionSettings& getDefaultSettings() const;

    QPID_CLIENT_EXTERN SubscriptionSettings& getDefaultSettings();

    QPID_CLIENT_EXTERN void setFlowControl(uint32_t messages,  uint32_t bytes, bool window=true);

    QPID_CLIENT_EXTERN void setAcceptMode(AcceptMode mode);

    QPID_CLIENT_EXTERN void setAcquireMode(AcquireMode mode);

    QPID_CLIENT_EXTERN void registerFailoverHandler ( boost::function<void ()> fh );

    QPID_CLIENT_EXTERN Session getSession() const;

    SubscriptionManager(SubscriptionManagerImpl*); 

  private:
    typedef SubscriptionManagerImpl Impl;
    friend class PrivateImplRef<SubscriptionManager>;
};

class AutoCancel {
  public:
    AutoCancel(SubscriptionManager& sm_, const std::string& tag_) : sm(sm_), tag(tag_) {}
    ~AutoCancel() { sm.cancel(tag); }
  private:
    SubscriptionManager& sm;
    std::string tag;
};

}} // namespace qpid::client

#endif