VisibilityTimeout Property

The visibility duration for messages in the queue.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetVisibilityTimeout();
int SetVisibilityTimeout(int iVisibilityTimeout);

Unicode (Windows)
INT GetVisibilityTimeout();
INT SetVisibilityTimeout(INT iVisibilityTimeout);

@property (nonatomic,readwrite,assign,getter=visibilityTimeout,setter=setVisibilityTimeout:) int visibilityTimeout;
- (int)visibilityTimeout;
- (void)setVisibilityTimeout:(int)newVisibilityTimeout;

#define PID_AMAZONSQS_VISIBILITYTIMEOUT 42

IPWORKSMQ_EXTERNAL void* IPWORKSMQ_CALL IPWorksMQ_AmazonSQS_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
IPWORKSMQ_EXTERNAL int IPWORKSMQ_CALL IPWorksMQ_AmazonSQS_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

-1

Remarks

Visibility timeout is used to guard against multiple delivery. Successive calls to ListMessages on a queue will not return any message again until the timeout expires, after which the message may reappear unless deleted with DeleteMessage.

A default visibility timeout is configured when a queue is created using CreateQueue, it can also be altered when a message is added using CreateMessage or when they are retrieved using ListMessages.

The default value for VisibilityTimeout is -1, which notifies the component that you would like to use the default behavior for the current Queue.

Note: Unlike messages received from standard queues, messages received from FIFO queues can only be deleted within their VisibilityTimeout. Attempting to call DeleteMessage for a message received from a FIFO queue after its VisibilityTimeout has expired will cause the server to return an error. Keep this in mind when picking a VisibilityTimeout value to create a FIFO queue and/or retrieve messages with.

Data Type

Integer