Loading...
Searching...
No Matches
terminus.h
Go to the documentation of this file.
#ifndef PROTON_TERMINUS_H
#define PROTON_TERMINUS_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/type_compat.h>
#include <proton/codec.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct pn_terminus_t pn_terminus_t;
typedef enum {
PN_UNSPECIFIED = 0,
PN_SOURCE = 1,
PN_TARGET = 2,
PN_COORDINATOR = 3
} pn_terminus_type_t;
typedef enum {
PN_NONDURABLE = 0,
PN_CONFIGURATION = 1,
PN_DELIVERIES = 2
} pn_durability_t;
typedef enum {
PN_EXPIRE_WITH_LINK,
PN_EXPIRE_WITH_SESSION,
PN_EXPIRE_WITH_CONNECTION,
PN_EXPIRE_NEVER
} pn_expiry_policy_t;
typedef enum {
PN_DIST_MODE_UNSPECIFIED = 0,
PN_DIST_MODE_COPY = 1,
PN_DIST_MODE_MOVE = 2
} pn_distribution_mode_t;
PN_EXTERN pn_terminus_type_t pn_terminus_get_type(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_type(pn_terminus_t *terminus, pn_terminus_type_t type);
PN_EXTERN const char *pn_terminus_get_address(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_address(pn_terminus_t *terminus, const char *address);
PN_EXTERN pn_distribution_mode_t pn_terminus_get_distribution_mode(const pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_distribution_mode(pn_terminus_t *terminus, pn_distribution_mode_t mode);
PN_EXTERN pn_durability_t pn_terminus_get_durability(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_durability(pn_terminus_t *terminus,
pn_durability_t durability);
PN_EXTERN pn_expiry_policy_t pn_terminus_get_expiry_policy(pn_terminus_t *terminus);
PN_EXTERN bool pn_terminus_has_expiry_policy(const pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_expiry_policy(pn_terminus_t *terminus, pn_expiry_policy_t policy);
PN_EXTERN pn_seconds_t pn_terminus_get_timeout(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_timeout(pn_terminus_t *terminus, pn_seconds_t timeout);
PN_EXTERN bool pn_terminus_is_dynamic(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_set_dynamic(pn_terminus_t *terminus, bool dynamic);
PN_EXTERN pn_data_t *pn_terminus_properties(pn_terminus_t *terminus);
PN_EXTERN pn_data_t *pn_terminus_capabilities(pn_terminus_t *terminus);
PN_EXTERN pn_data_t *pn_terminus_outcomes(pn_terminus_t *terminus);
PN_EXTERN pn_data_t *pn_terminus_filter(pn_terminus_t *terminus);
PN_EXTERN int pn_terminus_copy(pn_terminus_t *terminus, pn_terminus_t *src);
#ifdef __cplusplus
}
#endif
#endif /* terminus.h */
codec.h
AMQP data encoding and decoding.
pn_seconds_t
uint32_t pn_seconds_t
A span of time in seconds.
Definition types.h:163
pn_data_t
struct pn_data_t pn_data_t
An AMQP Data object.
Definition codec.h:375
pn_terminus_set_address
int pn_terminus_set_address(pn_terminus_t *terminus, const char *address)
Set the address of a terminus object.
pn_terminus_outcomes
pn_data_t * pn_terminus_outcomes(pn_terminus_t *terminus)
Access/modify the AMQP outcomes for a terminus object.
pn_terminus_get_expiry_policy
pn_expiry_policy_t pn_terminus_get_expiry_policy(pn_terminus_t *terminus)
Get the expiry policy of a terminus object.
pn_durability_t
pn_durability_t
Durability mode of an AMQP terminus.
Definition terminus.h:75
pn_terminus_get_address
const char * pn_terminus_get_address(pn_terminus_t *terminus)
Get the address of a terminus object.
pn_terminus_get_type
pn_terminus_type_t pn_terminus_get_type(pn_terminus_t *terminus)
Get the type of a terminus object.
pn_terminus_capabilities
pn_data_t * pn_terminus_capabilities(pn_terminus_t *terminus)
Access/modify the AMQP capabilities data for a terminus object.
pn_terminus_type_t
pn_terminus_type_t
Type of an AMQP terminus.
Definition terminus.h:58
pn_terminus_filter
pn_data_t * pn_terminus_filter(pn_terminus_t *terminus)
Access/modify the AMQP filter set for a terminus object.
pn_terminus_get_distribution_mode
pn_distribution_mode_t pn_terminus_get_distribution_mode(const pn_terminus_t *terminus)
Get the distribution mode of a terminus object.
pn_terminus_get_timeout
pn_seconds_t pn_terminus_get_timeout(pn_terminus_t *terminus)
Get the timeout of a terminus object.
pn_terminus_set_dynamic
int pn_terminus_set_dynamic(pn_terminus_t *terminus, bool dynamic)
Set the dynamic flag for a terminus object.
pn_terminus_has_expiry_policy
bool pn_terminus_has_expiry_policy(const pn_terminus_t *terminus)
Return true if the terminus has an explicit expiry policy set, false if it does not.
pn_terminus_set_type
int pn_terminus_set_type(pn_terminus_t *terminus, pn_terminus_type_t type)
Set the type of a terminus object.
pn_terminus_set_timeout
int pn_terminus_set_timeout(pn_terminus_t *terminus, pn_seconds_t timeout)
Set the timeout of a terminus object.
pn_terminus_copy
int pn_terminus_copy(pn_terminus_t *terminus, pn_terminus_t *src)
Copy a terminus object.
pn_terminus_set_expiry_policy
int pn_terminus_set_expiry_policy(pn_terminus_t *terminus, pn_expiry_policy_t policy)
Set the expiry policy of a terminus object.
pn_terminus_set_distribution_mode
int pn_terminus_set_distribution_mode(pn_terminus_t *terminus, pn_distribution_mode_t mode)
Set the distribution mode of a terminus object.
pn_terminus_properties
pn_data_t * pn_terminus_properties(pn_terminus_t *terminus)
Access/modify the AMQP properties data for a terminus object.
pn_expiry_policy_t
pn_expiry_policy_t
Expiry policy of an AMQP terminus.
Definition terminus.h:92
pn_terminus_set_durability
int pn_terminus_set_durability(pn_terminus_t *terminus, pn_durability_t durability)
Set the durability mode of a terminus object.
pn_distribution_mode_t
pn_distribution_mode_t
Distribution mode of an AMQP terminus.
Definition terminus.h:106
pn_terminus_t
struct pn_terminus_t pn_terminus_t
Encapsulates the endpoint state associated with an AMQP Terminus.
Definition terminus.h:53
pn_terminus_get_durability
pn_durability_t pn_terminus_get_durability(pn_terminus_t *terminus)
Get the durability mode of a terminus object.
pn_terminus_is_dynamic
bool pn_terminus_is_dynamic(pn_terminus_t *terminus)
Get the dynamic flag for a terminus object.
PN_NONDURABLE
@ PN_NONDURABLE
indicates a non durable terminus
Definition terminus.h:76
PN_CONFIGURATION
@ PN_CONFIGURATION
indicates a terminus with durably held configuration, but not delivery state
Definition terminus.h:77
PN_DELIVERIES
@ PN_DELIVERIES
indicates a terminus with both durably held configuration and durably held delivery state.
Definition terminus.h:79
PN_COORDINATOR
@ PN_COORDINATOR
a special target identifying a transaction coordinator
Definition terminus.h:63
PN_TARGET
@ PN_TARGET
indicates a target for messages
Definition terminus.h:62
PN_SOURCE
@ PN_SOURCE
indicates a source of messages
Definition terminus.h:61
PN_UNSPECIFIED
@ PN_UNSPECIFIED
indicates a nonexistent terminus, may used as a source or target
Definition terminus.h:59
PN_EXPIRE_WITH_SESSION
@ PN_EXPIRE_WITH_SESSION
the terminus is orphaned when the parent session is closed
Definition terminus.h:94
PN_EXPIRE_WITH_CONNECTION
@ PN_EXPIRE_WITH_CONNECTION
the terminus is orphaned when the parent connection is closed
Definition terminus.h:95
PN_EXPIRE_NEVER
@ PN_EXPIRE_NEVER
the terminus is never considered orphaned
Definition terminus.h:96
PN_EXPIRE_WITH_LINK
@ PN_EXPIRE_WITH_LINK
the terminus is orphaned when the parent link is closed
Definition terminus.h:93
PN_DIST_MODE_UNSPECIFIED
@ PN_DIST_MODE_UNSPECIFIED
the behaviour is defined by the node
Definition terminus.h:107
PN_DIST_MODE_COPY
@ PN_DIST_MODE_COPY
the receiver gets all messages
Definition terminus.h:108
PN_DIST_MODE_MOVE
@ PN_DIST_MODE_MOVE
the receiver competes for messages
Definition terminus.h:109