qpid/messaging/Receiver.h

Go to the documentation of this file.

#ifndef QPID_MESSAGING_RECEIVER_H
#define QPID_MESSAGING_RECEIVER_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/messaging/ImportExport.h"

#include "qpid/messaging/exceptions.h"
#include "qpid/messaging/Handle.h"
#include "qpid/messaging/Duration.h"

namespace qpid {
namespace messaging {

#ifndef SWIG
template <class> class PrivateImplRef;
#endif

class Message;
class ReceiverImpl;
class Session;

class QPID_MESSAGING_CLASS_EXTERN Receiver : public qpid::messaging::Handle<ReceiverImpl>
{
  public:
    QPID_MESSAGING_EXTERN Receiver(ReceiverImpl* impl = 0);
    QPID_MESSAGING_EXTERN Receiver(const Receiver&);
    QPID_MESSAGING_EXTERN ~Receiver();
    QPID_MESSAGING_EXTERN Receiver& operator=(const Receiver&);
    QPID_MESSAGING_EXTERN bool get(Message& message, Duration timeout=Duration::FOREVER);
    QPID_MESSAGING_EXTERN Message get(Duration timeout=Duration::FOREVER);
    QPID_MESSAGING_EXTERN bool fetch(Message& message, Duration timeout=Duration::FOREVER);
    QPID_MESSAGING_EXTERN Message fetch(Duration timeout=Duration::FOREVER);
    QPID_MESSAGING_EXTERN void setCapacity(uint32_t);
    QPID_MESSAGING_EXTERN uint32_t getCapacity();
    QPID_MESSAGING_EXTERN uint32_t getAvailable();
    QPID_MESSAGING_EXTERN uint32_t getUnsettled();

    QPID_MESSAGING_EXTERN void close();

    QPID_MESSAGING_EXTERN bool isClosed() const;

    QPID_MESSAGING_EXTERN const std::string& getName() const;

    QPID_MESSAGING_EXTERN Session getSession() const;

#ifndef SWIG
  private:
  friend class qpid::messaging::PrivateImplRef<Receiver>;
#endif
};
}} // namespace qpid::messaging

#endif