message.hpp

Go to the documentation of this file.

#ifndef PROTON_MESSAGE_HPP
#define PROTON_MESSAGE_HPP
 
/*
 *
 * 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 "./fwd.hpp"
#include "./internal/export.hpp"
#include "./duration.hpp"
#include "./timestamp.hpp"
#include "./value.hpp"
#include "./map.hpp"
 
#include <proton/type_compat.h>
 
#include <string>
#include <vector>
 
 
struct pn_message_t;
 
namespace proton {
 
class message {
  public:
    typedef map<std::string, scalar> property_map;
 
    typedef map<annotation_key, value> annotation_map;
 
    PN_CPP_EXTERN message();
 
    PN_CPP_EXTERN message(const message&);
 
    PN_CPP_EXTERN message& operator=(const message&);
 
    PN_CPP_EXTERN message(message&&);
 
    PN_CPP_EXTERN message& operator=(message&&);
 
    PN_CPP_EXTERN message(const value& x);
 
    PN_CPP_EXTERN ~message();
 
 
    PN_CPP_EXTERN void clear();
 
    PN_CPP_EXTERN void id(const message_id&);
 
    PN_CPP_EXTERN message_id id() const;
 
    PN_CPP_EXTERN void user(const std::string&);
 
    PN_CPP_EXTERN std::string user() const;
 
    PN_CPP_EXTERN void encode(std::vector<char>&) const;
 
    PN_CPP_EXTERN std::vector<char> encode() const;
 
    PN_CPP_EXTERN void decode(const std::vector<char>&);
 
 
 
    PN_CPP_EXTERN void to(const std::string&);
 
    PN_CPP_EXTERN std::string to() const;
 
    PN_CPP_EXTERN void address(const std::string&);
    PN_CPP_EXTERN std::string address() const;
 
    PN_CPP_EXTERN void reply_to(const std::string&);
 
    PN_CPP_EXTERN std::string reply_to() const;
 
    PN_CPP_EXTERN void correlation_id(const message_id&);
 
    PN_CPP_EXTERN message_id correlation_id() const;
 
 
 
    PN_CPP_EXTERN void body(const value& x);
 
    PN_CPP_EXTERN const value& body() const;
 
    PN_CPP_EXTERN value& body();
 
    PN_CPP_EXTERN void subject(const std::string&);
 
    PN_CPP_EXTERN std::string subject() const;
 
    PN_CPP_EXTERN void content_type(const std::string&);
 
    PN_CPP_EXTERN std::string content_type() const;
 
    PN_CPP_EXTERN void content_encoding(const std::string&);
 
    PN_CPP_EXTERN std::string content_encoding() const;
 
    PN_CPP_EXTERN void expiry_time(timestamp);
 
    PN_CPP_EXTERN timestamp expiry_time() const;
 
    PN_CPP_EXTERN void creation_time(timestamp);
 
    PN_CPP_EXTERN timestamp creation_time() const;
 
    PN_CPP_EXTERN bool inferred() const;
 
    PN_CPP_EXTERN void inferred(bool);
 
 
 
    PN_CPP_EXTERN bool durable() const;
 
    PN_CPP_EXTERN void durable(bool);
 
    PN_CPP_EXTERN duration ttl() const;
 
    PN_CPP_EXTERN void ttl(duration);
 
    PN_CPP_EXTERN uint8_t priority() const;
 
    PN_CPP_EXTERN void priority(uint8_t);
 
 
    // XXX The triple-not in the last sentence above is confusing.
 
    PN_CPP_EXTERN bool first_acquirer() const;
 
    PN_CPP_EXTERN void first_acquirer(bool);
 
    PN_CPP_EXTERN uint32_t delivery_count() const;
 
    PN_CPP_EXTERN void delivery_count(uint32_t);
 
 
 
    PN_CPP_EXTERN void group_id(const std::string&);
 
    PN_CPP_EXTERN std::string group_id() const;
 
    PN_CPP_EXTERN void reply_to_group_id(const std::string&);
 
    PN_CPP_EXTERN std::string reply_to_group_id() const;
 
    PN_CPP_EXTERN int32_t group_sequence() const;
 
    PN_CPP_EXTERN void group_sequence(int32_t);
 
 
 
    PN_CPP_EXTERN property_map& properties();
 
    PN_CPP_EXTERN const property_map& properties() const;
 
    PN_CPP_EXTERN annotation_map& message_annotations();
 
    PN_CPP_EXTERN const annotation_map& message_annotations() const;
 
    PN_CPP_EXTERN annotation_map& delivery_annotations();
 
    PN_CPP_EXTERN const annotation_map& delivery_annotations() const;
 
 
    PN_CPP_EXTERN static const uint8_t default_priority;
 
    friend PN_CPP_EXTERN std::ostream& operator<<(std::ostream&, const message&);
 
  private:
    struct impl;
    pn_message_t* pn_msg() const;
    struct impl& impl() const;
 
    mutable pn_message_t* pn_msg_;
 
  PN_CPP_EXTERN friend void swap(message&, message&);
};
 
PN_CPP_EXTERN std::string to_string(const message&);
 
} // proton
 
#endif // PROTON_MESSAGE_HPP