Endpoint Configuration Properties

Endpoint properties are passed to solClient_session_endpointProvision()/solClient_session_endpointDeprovision(). More...

Macros
#define	SOLCLIENT_ENDPOINT_PROP_ID   "ENDPOINT_ID"
	The type of endpoint, the valid values are SOLCLIENT_ENDPOINT_PROP_QUEUE, SOLCLIENT_ENDPOINT_PROP_TE, and SOLCLIENT_ENDPOINT_PROP_CLIENT_NAME. More...
#define	SOLCLIENT_ENDPOINT_PROP_NAME   "ENDPOINT_NAME"
	The name of the Queue or Topic endpoint as a NULL-terminated UTF-8 encoded string. More...
#define	SOLCLIENT_ENDPOINT_PROP_DURABLE   "ENDPOINT_DURABLE"
	The durability of the endpoint to name. More...
#define	SOLCLIENT_ENDPOINT_PROP_PERMISSION   "ENDPOINT_PERMISSION"
	The created entity's permissions, a single character string. More...
#define	SOLCLIENT_ENDPOINT_PROP_ACCESSTYPE   "ENDPOINT_ACCESSTYPE"
	Sets the access type for the endpoint. More...
#define	SOLCLIENT_ENDPOINT_PROP_QUOTA_MB   "ENDPOINT_QUOTA_MB"
	Maximum quota (in megabytes) for the endpoint. More...
#define	SOLCLIENT_ENDPOINT_PROP_MAXMSG_SIZE   "ENDPOINT_MAXMSG_SIZE"
	Maximum size (in bytes) for any one message stored in the endpoint. More...
#define	SOLCLIENT_ENDPOINT_PROP_RESPECTS_MSG_TTL   "ENDPOINT_RESPECTS_MSG_TTL"
	The endpoint observes message Time-to-Live (TTL) values and can remove expired messages. More...
#define	SOLCLIENT_ENDPOINT_PROP_DISCARD_BEHAVIOR   "ENDPOINT_DISCARD_BEHAVIOR"
	When a message cannot be added to an endpoint (for example, maximum quota (SOLCLIENT_ENDPOINT_PROP_QUOTA_MB) exceeded), this property controls the action the broker will perform towards the publisher. More...
#define	SOLCLIENT_ENDPOINT_PROP_MAXMSG_REDELIVERY   "ENDPOINT_MAXMSG_REDELIVERY"
	Defines how many message redelivery retries before discarding or moving the message to the DMQ. More...

Detailed Description

Endpoint properties are passed to solClient_session_endpointProvision()/solClient_session_endpointDeprovision().

The properties describe the endpoint (Queue or Topic Endpoint) to be created or destroyed on the target broker.

Endpoint properties can be used to describe a non-durable endpoint (Queue or Topic Endpoint) in solClient_session_createFlow().

Endpoint properties are also used to identify in the endpoint (Queue or ClientName) in solClient_session_endpointTopicSubscribe() and solClient_session_endpointTopicUnsubscribe(). Only in this interface is the special endpoint, SOLCLIENT_ENDPOINT_PROP_CLIENT_NAME a valid option. Authorized Sessions can add a subscription to queues or to other client Sessions.

Items that can be configured for a create endpoint operation.

Macro Definition Documentation

#define SOLCLIENT_ENDPOINT_PROP_ACCESSTYPE   "ENDPOINT_ACCESSTYPE"

Sets the access type for the endpoint.

This applies to durable Queues only.

Examples:

ex/activeFlowIndication.c.

#define SOLCLIENT_ENDPOINT_PROP_DISCARD_BEHAVIOR   "ENDPOINT_DISCARD_BEHAVIOR"

When a message cannot be added to an endpoint (for example, maximum quota (SOLCLIENT_ENDPOINT_PROP_QUOTA_MB) exceeded), this property controls the action the broker will perform towards the publisher.

Examples:

ex/queueProvision.c, and ex/simpleFlowToQueue.c.

#define SOLCLIENT_ENDPOINT_PROP_DURABLE   "ENDPOINT_DURABLE"

The durability of the endpoint to name.

Default: SOLCLIENT_PROP_ENABLE_VAL, which means the endpoint is durable. Only SOLCLIENT_PROP_ENABLE_VAL is supported in solClient_session_endpointProvision(). This property is ignored in solClient_session_creatFlow().

#define SOLCLIENT_ENDPOINT_PROP_ID   "ENDPOINT_ID"

The type of endpoint, the valid values are SOLCLIENT_ENDPOINT_PROP_QUEUE, SOLCLIENT_ENDPOINT_PROP_TE, and SOLCLIENT_ENDPOINT_PROP_CLIENT_NAME.

Default: SOLCLIENT_ENDPOINT_PROP_TE

Examples:

ex/activeFlowIndication.c, ex/common.c, ex/ios/examples/SubscribeOnBehalfOfClientExample.m, ex/messageTTLAndDeadMessageQueue.c, ex/perfADSub.c, ex/queueProvision.c, ex/RRGuaranteedReplier.c, ex/subscribeOnBehalfOfClient.c, ex/topicToQueueMapping.c, ex/transactions.c, and Intro/HelloWorldQueueSub.c.

#define SOLCLIENT_ENDPOINT_PROP_MAXMSG_REDELIVERY   "ENDPOINT_MAXMSG_REDELIVERY"

Defines how many message redelivery retries before discarding or moving the message to the DMQ.

The valid ranges is {0..255} where 0 means retry forever. Default: 0

Examples:

ex/queueProvision.c, and ex/simpleFlowToQueue.c.

#define SOLCLIENT_ENDPOINT_PROP_MAXMSG_SIZE   "ENDPOINT_MAXMSG_SIZE"

Maximum size (in bytes) for any one message stored in the endpoint.

Examples:

ex/queueProvision.c, and ex/simpleFlowToQueue.c.

#define SOLCLIENT_ENDPOINT_PROP_NAME   "ENDPOINT_NAME"

The name of the Queue or Topic endpoint as a NULL-terminated UTF-8 encoded string.

Examples:

ex/activeFlowIndication.c, ex/common.c, ex/ios/examples/SubscribeOnBehalfOfClientExample.m, ex/messageTTLAndDeadMessageQueue.c, ex/perfADSub.c, ex/queueProvision.c, ex/RRGuaranteedReplier.c, ex/subscribeOnBehalfOfClient.c, ex/topicToQueueMapping.c, ex/transactions.c, and Intro/HelloWorldQueueSub.c.

#define SOLCLIENT_ENDPOINT_PROP_PERMISSION   "ENDPOINT_PERMISSION"

The created entity's permissions, a single character string.

Permissions can be SOLCLIENT_ENDPOINT_PERM_DELETE, SOLCLIENT_ENDPOINT_PERM_MODIFY_TOPIC, SOLCLIENT_ENDPOINT_PERM_CONSUME, SOLCLIENT_ENDPOINT_PERM_READ_ONLY, SOLCLIENT_ENDPOINT_PERM_NONE.

Examples:

ex/activeFlowIndication.c, ex/common.c, ex/perfADSub.c, ex/queueProvision.c, ex/RRGuaranteedReplier.c, ex/simpleFlowToQueue.c, ex/transactions.c, and Intro/HelloWorldQueueSub.c.

#define SOLCLIENT_ENDPOINT_PROP_QUOTA_MB   "ENDPOINT_QUOTA_MB"

Maximum quota (in megabytes) for the endpoint.

A value of 0 configures the endpoint to act as a Last-Value-Queue (LVQ), where the broker enforces a Queue depth of one, and only the most current message is spooled by the endpoint. When a new message is received, the current queued message is automatically deleted from the endpoint and the new message is spooled.

Examples:

ex/activeFlowIndication.c, ex/perfADSub.c, ex/queueProvision.c, ex/RRGuaranteedReplier.c, ex/simpleFlowToQueue.c, ex/transactions.c, and Intro/HelloWorldQueueSub.c.

#define SOLCLIENT_ENDPOINT_PROP_RESPECTS_MSG_TTL   "ENDPOINT_RESPECTS_MSG_TTL"

The endpoint observes message Time-to-Live (TTL) values and can remove expired messages.

Default: SOLCLIENT_ENDPOINT_PROP_DEFAULT_RESPECTS_MSG_TTL

Examples:

ex/common.c.