Qpid Proton C API  0.18.1
disposition.h
Go to the documentation of this file.
1 #ifndef PROTON_DISPOSITION_H
2 #define PROTON_DISPOSITION_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/type_compat.h>
27 #include <proton/condition.h>
28 #include <stddef.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
53 
58 #define PN_RECEIVED (0x0000000000000023)
59 
66 #define PN_ACCEPTED (0x0000000000000024)
67 
74 #define PN_REJECTED (0x0000000000000025)
75 
82 #define PN_RELEASED (0x0000000000000026)
83 
91 #define PN_MODIFIED (0x0000000000000027)
92 
107 PN_EXTERN uint64_t pn_disposition_type(pn_disposition_t *disposition);
108 
112 PN_EXTERN const char *pn_disposition_type_name(uint64_t disposition_type);
113 
130 
146 PN_EXTERN pn_data_t *pn_disposition_data(pn_disposition_t *disposition);
147 
154 PN_EXTERN uint32_t pn_disposition_get_section_number(pn_disposition_t *disposition);
155 
162 PN_EXTERN void pn_disposition_set_section_number(pn_disposition_t *disposition, uint32_t section_number);
163 
170 PN_EXTERN uint64_t pn_disposition_get_section_offset(pn_disposition_t *disposition);
171 
178 PN_EXTERN void pn_disposition_set_section_offset(pn_disposition_t *disposition, uint64_t section_offset);
179 
186 PN_EXTERN bool pn_disposition_is_failed(pn_disposition_t *disposition);
187 
194 PN_EXTERN void pn_disposition_set_failed(pn_disposition_t *disposition, bool failed);
195 
202 PN_EXTERN bool pn_disposition_is_undeliverable(pn_disposition_t *disposition);
203 
210 PN_EXTERN void pn_disposition_set_undeliverable(pn_disposition_t *disposition, bool undeliverable);
211 
228 PN_EXTERN pn_data_t *pn_disposition_annotations(pn_disposition_t *disposition);
229 
234 #ifdef __cplusplus
235 }
236 #endif
237 
238 #endif /* disposition.h */
pn_condition_t * pn_disposition_condition(pn_disposition_t *disposition)
Access the condition object associated with a disposition.
bool pn_disposition_is_undeliverable(pn_disposition_t *disposition)
Check if a disposition has the undeliverable flag set.
bool pn_disposition_is_failed(pn_disposition_t *disposition)
Check if a disposition has the failed flag set.
void pn_disposition_set_undeliverable(pn_disposition_t *disposition, bool undeliverable)
Set the undeliverable flag on a disposition.
An endpoint error state.
struct pn_disposition_t pn_disposition_t
A delivery state.
Definition: disposition.h:52
void pn_disposition_set_failed(pn_disposition_t *disposition, bool failed)
Set the failed flag on a disposition.
struct pn_data_t pn_data_t
An AMQP Data object.
Definition: codec.h:364
pn_data_t * pn_disposition_data(pn_disposition_t *disposition)
Access the disposition as a raw pn_data_t.
void pn_disposition_set_section_offset(pn_disposition_t *disposition, uint64_t section_offset)
Set the section offset associated with a disposition.
uint32_t pn_disposition_get_section_number(pn_disposition_t *disposition)
Get the section number associated with a disposition.
uint64_t pn_disposition_get_section_offset(pn_disposition_t *disposition)
Get the section offset associated with a disposition.
const char * pn_disposition_type_name(uint64_t disposition_type)
Name of a disposition type for logging and debugging: "received", "accepted" etc. ...
struct pn_condition_t pn_condition_t
An AMQP Condition object.
Definition: condition.h:64
uint64_t pn_disposition_type(pn_disposition_t *disposition)
Get the type of a disposition.
pn_data_t * pn_disposition_annotations(pn_disposition_t *disposition)
Access the annotations associated with a disposition.
void pn_disposition_set_section_number(pn_disposition_t *disposition, uint32_t section_number)
Set the section number associated with a disposition.