Qpid Proton C API  0.18.0
terminus.h
Go to the documentation of this file.
1 #ifndef PROTON_TERMINUS_H
2 #define PROTON_TERMINUS_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/codec.h>
28 #include <stddef.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
54 
58 typedef enum {
61  PN_SOURCE = 1,
62  PN_TARGET = 2,
66 
75 typedef enum {
83 
92 typedef enum {
98 
106 typedef enum {
111 
119 
127 PN_EXTERN int pn_terminus_set_type(pn_terminus_t *terminus, pn_terminus_type_t type);
128 
139 PN_EXTERN const char *pn_terminus_get_address(pn_terminus_t *terminus);
140 
148 PN_EXTERN int pn_terminus_set_address(pn_terminus_t *terminus, const char *address);
149 
157 
166 
174 
182 PN_EXTERN int pn_terminus_set_durability(pn_terminus_t *terminus,
183  pn_durability_t durability);
184 
191 PN_EXTERN pn_expiry_policy_t pn_terminus_get_expiry_policy(pn_terminus_t *terminus);
192 
200 PN_EXTERN int pn_terminus_set_expiry_policy(pn_terminus_t *terminus, pn_expiry_policy_t policy);
201 
209 
217 PN_EXTERN int pn_terminus_set_timeout(pn_terminus_t *terminus, pn_seconds_t timeout);
218 
225 PN_EXTERN bool pn_terminus_is_dynamic(pn_terminus_t *terminus);
226 
234 PN_EXTERN int pn_terminus_set_dynamic(pn_terminus_t *terminus, bool dynamic);
235 
248 PN_EXTERN pn_data_t *pn_terminus_properties(pn_terminus_t *terminus);
249 
262 PN_EXTERN pn_data_t *pn_terminus_capabilities(pn_terminus_t *terminus);
263 
276 PN_EXTERN pn_data_t *pn_terminus_outcomes(pn_terminus_t *terminus);
277 
290 PN_EXTERN pn_data_t *pn_terminus_filter(pn_terminus_t *terminus);
291 
299 PN_EXTERN int pn_terminus_copy(pn_terminus_t *terminus, pn_terminus_t *src);
300 
305 #ifdef __cplusplus
306 }
307 #endif
308 
309 #endif /* terminus.h */
int pn_terminus_set_timeout(pn_terminus_t *terminus, pn_seconds_t timeout)
Set the timeout of a terminus object.
the terminus is orphaned when the parent session is closed
Definition: terminus.h:94
indicates a source of messages
Definition: terminus.h:61
int pn_terminus_set_type(pn_terminus_t *terminus, pn_terminus_type_t type)
Set the type of a terminus object.
int pn_terminus_set_address(pn_terminus_t *terminus, const char *address)
Set the address of a terminus object.
AMQP data encoding and decoding.
int pn_terminus_copy(pn_terminus_t *terminus, pn_terminus_t *src)
Copy a terminus object.
pn_distribution_mode_t pn_terminus_get_distribution_mode(const pn_terminus_t *terminus)
Get the distribution mode of a terminus object.
pn_terminus_type_t pn_terminus_get_type(pn_terminus_t *terminus)
Get the type of a terminus object.
indicates a terminus with both durably held configuration and durably held delivery state...
Definition: terminus.h:79
struct pn_terminus_t pn_terminus_t
Encapsulates the endpoint state associated with an AMQP Terminus.
Definition: terminus.h:53
pn_durability_t
Durability mode of an AMQP terminus.
Definition: terminus.h:75
pn_terminus_type_t
Type of an AMQP terminus.
Definition: terminus.h:58
int pn_terminus_set_expiry_policy(pn_terminus_t *terminus, pn_expiry_policy_t policy)
Set the expiry policy of a terminus object.
pn_data_t * pn_terminus_outcomes(pn_terminus_t *terminus)
Access/modify the AMQP outcomes for a terminus object.
const char * pn_terminus_get_address(pn_terminus_t *terminus)
Get the address of a terminus object.
the terminus is never considered orphaned
Definition: terminus.h:96
int pn_terminus_set_durability(pn_terminus_t *terminus, pn_durability_t durability)
Set the durability mode of a terminus object.
indicates a non durable terminus
Definition: terminus.h:76
pn_data_t * pn_terminus_filter(pn_terminus_t *terminus)
Access/modify the AMQP filter set for a terminus object.
int pn_terminus_set_distribution_mode(pn_terminus_t *terminus, pn_distribution_mode_t mode)
Set the distribution mode of a terminus object.
pn_data_t * pn_terminus_capabilities(pn_terminus_t *terminus)
Access/modify the AMQP capabilities data for a terminus object.
pn_data_t * pn_terminus_properties(pn_terminus_t *terminus)
Access/modify the AMQP properties data for a terminus object.
struct pn_data_t pn_data_t
An AMQP Data object.
Definition: codec.h:364
the behaviour is defined by the node
Definition: terminus.h:107
uint32_t pn_seconds_t
A span of time in seconds.
Definition: types.h:159
the receiver competes for messages
Definition: terminus.h:109
pn_expiry_policy_t
Expiry policy of an AMQP terminus.
Definition: terminus.h:92
pn_expiry_policy_t pn_terminus_get_expiry_policy(pn_terminus_t *terminus)
Get the expiry policy of a terminus object.
the terminus is orphaned when the parent connection is closed
Definition: terminus.h:95
pn_distribution_mode_t
Distribution mode of an AMQP terminus.
Definition: terminus.h:106
indicates a nonexistent terminus, may used as a source or target
Definition: terminus.h:59
indicates a terminus with durably held configuration, but not delivery state
Definition: terminus.h:77
the receiver gets all messages
Definition: terminus.h:108
the terminus is orphaned when the parent link is closed
Definition: terminus.h:93
a special target identifying a transaction coordinator
Definition: terminus.h:63
pn_durability_t pn_terminus_get_durability(pn_terminus_t *terminus)
Get the durability mode of a terminus object.
int pn_terminus_set_dynamic(pn_terminus_t *terminus, bool dynamic)
Set the dynamic flag for a terminus object.
bool pn_terminus_is_dynamic(pn_terminus_t *terminus)
Get the dynamic flag for a terminus object.
indicates a target for messages
Definition: terminus.h:62
pn_seconds_t pn_terminus_get_timeout(pn_terminus_t *terminus)
Get the timeout of a terminus object.