Qpid Proton C API  0.17.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
delivery.h
Go to the documentation of this file.
1 #ifndef PROTON_DELIVERY_H
2 #define PROTON_DELIVERY_H 1
3 
4 /*
5  *
6  * Licensed to the Apache Software Foundation (ASF) under one
7  * or more contributor license agreements. See the NOTICE file
8  * distributed with this work for additional information
9  * regarding copyright ownership. The ASF licenses this file
10  * to you under the Apache License, Version 2.0 (the
11  * "License"); you may not use this file except in compliance
12  * with the License. You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing,
17  * software distributed under the License is distributed on an
18  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
19  * KIND, either express or implied. See the License for the
20  * specific language governing permissions and limitations
21  * under the License.
22  *
23  */
24 
25 #include <proton/import_export.h>
26 #include <proton/disposition.h>
27 #include <proton/type_compat.h>
28 #include <stddef.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
47 
55 PN_EXTERN pn_delivery_tag_t pn_dtag(const char *bytes, size_t size);
56 
68 PN_EXTERN pn_delivery_t *pn_delivery(pn_link_t *link, pn_delivery_tag_t tag);
69 
81 PN_EXTERN void *pn_delivery_get_context(pn_delivery_t *delivery);
82 
94 PN_EXTERN void pn_delivery_set_context(pn_delivery_t *delivery, void *context);
95 
102 PN_EXTERN pn_record_t *pn_delivery_attachments(pn_delivery_t *delivery);
103 
110 PN_EXTERN pn_delivery_tag_t pn_delivery_tag(pn_delivery_t *delivery);
111 
118 PN_EXTERN pn_link_t *pn_delivery_link(pn_delivery_t *delivery);
119 
129 PN_EXTERN pn_disposition_t *pn_delivery_local(pn_delivery_t *delivery);
130 
137 PN_EXTERN uint64_t pn_delivery_local_state(pn_delivery_t *delivery);
138 
149 
156 PN_EXTERN uint64_t pn_delivery_remote_state(pn_delivery_t *delivery);
157 
164 PN_EXTERN bool pn_delivery_settled(pn_delivery_t *delivery);
165 
172 PN_EXTERN size_t pn_delivery_pending(pn_delivery_t *delivery);
173 
180 PN_EXTERN bool pn_delivery_partial(pn_delivery_t *delivery);
181 
191 PN_EXTERN bool pn_delivery_writable(pn_delivery_t *delivery);
192 
202 PN_EXTERN bool pn_delivery_readable(pn_delivery_t *delivery);
203 
214 PN_EXTERN bool pn_delivery_updated(pn_delivery_t *delivery);
215 
225 PN_EXTERN void pn_delivery_update(pn_delivery_t *delivery, uint64_t state);
226 
234 PN_EXTERN void pn_delivery_clear(pn_delivery_t *delivery);
235 
242 PN_EXTERN bool pn_delivery_current(pn_delivery_t *delivery);
243 
254 PN_EXTERN void pn_delivery_settle(pn_delivery_t *delivery);
255 
261 PN_EXTERN void pn_delivery_dump(pn_delivery_t *delivery);
262 
275 PN_EXTERN bool pn_delivery_buffered(pn_delivery_t *delivery);
276 
293 PN_EXTERN pn_delivery_t *pn_work_head(pn_connection_t *connection);
294 
304 PN_EXTERN pn_delivery_t *pn_work_next(pn_delivery_t *delivery);
305 
310 #ifdef __cplusplus
311 }
312 #endif
313 
314 #endif /* delivery.h */