/*
* Copyright 2018 the original author or authors.
*
* Licensed 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.
*/
package io.vertx.proton.streams;
import org.apache.qpid.proton.amqp.transport.DeliveryState;
import org.apache.qpid.proton.message.Message;

public interface Delivery {

  
Retrieve the message object carried by this delivery.
Returns:
the message/**
   * Retrieve the message object carried by this delivery.
   *
   * @return the message
   */
  Message message();

  
Accepts (and settles) this message delivery.
Equivalent to calling disposition(Accepted.getInstance(), true);
Returns:
the delivery/**
   * Accepts (and settles) this message delivery.
   *
   * Equivalent to calling disposition(Accepted.getInstance(), true);
   *
   * @return the delivery
   */
  Delivery accept();

  
Updates the DeliveryState, and optionally settle the delivery as well.
Params:
state – 
         the delivery state to apply
settle – 
         whether to settle the delivery at the same time
Returns:
the delivery/**
   * Updates the DeliveryState, and optionally settle the delivery as well.
   *
   * @param state
   *          the delivery state to apply
   * @param settle
   *          whether to settle the delivery at the same time
   * @return the delivery
   */
  Delivery disposition(DeliveryState state, boolean settle);
}