delivery.h

Go to the documentation of this file.

#ifndef PROTON_DELIVERY_H
#define PROTON_DELIVERY_H 1
 
/*
 *
 * 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 <proton/import_export.h>
#include <proton/disposition.h>
#include <proton/type_compat.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef pn_bytes_t pn_delivery_tag_t;
 
PN_EXTERN pn_delivery_tag_t pn_dtag(const char *bytes, size_t size);
 
PN_EXTERN pn_delivery_t *pn_delivery(pn_link_t *link, pn_delivery_tag_t tag);
 
PN_EXTERN void *pn_delivery_get_context(pn_delivery_t *delivery);
 
PN_EXTERN void pn_delivery_set_context(pn_delivery_t *delivery, void *context);
 
PN_EXTERN pn_record_t *pn_delivery_attachments(pn_delivery_t *delivery);
 
PN_EXTERN pn_delivery_tag_t pn_delivery_tag(pn_delivery_t *delivery);
 
PN_EXTERN pn_link_t *pn_delivery_link(pn_delivery_t *delivery);
 
PN_EXTERN pn_disposition_t *pn_delivery_local(pn_delivery_t *delivery);
 
PN_EXTERN uint64_t pn_delivery_local_state(pn_delivery_t *delivery);
 
PN_EXTERN pn_disposition_t *pn_delivery_remote(pn_delivery_t *delivery);
 
PN_EXTERN uint64_t pn_delivery_remote_state(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_settled(pn_delivery_t *delivery);
 
PN_EXTERN size_t pn_delivery_pending(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_partial(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_aborted(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_writable(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_readable(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_updated(pn_delivery_t *delivery);
 
PN_EXTERN void pn_delivery_update(pn_delivery_t *delivery, uint64_t state);
 
PN_EXTERN void pn_delivery_clear(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_current(pn_delivery_t *delivery);
 
PN_EXTERN void pn_delivery_abort(pn_delivery_t *delivery);
 
PN_EXTERN void pn_delivery_settle(pn_delivery_t *delivery);
 
PN_EXTERN void pn_delivery_dump(pn_delivery_t *delivery);
 
PN_EXTERN bool pn_delivery_buffered(pn_delivery_t *delivery);
 
PN_DEPRECATED("Use the PN_DELIVERY event to track deliveries with pending operations")
PN_EXTERN pn_delivery_t *pn_work_head(pn_connection_t *connection);
 
PN_DEPRECATED("Use the PN_DELIVERY event to track deliveries with pending operations")
PN_EXTERN pn_delivery_t *pn_work_next(pn_delivery_t *delivery);
 
#ifdef __cplusplus
}
#endif
 
#endif /* delivery.h */