oof: Content from Server

The oof message indicates that a previously-received message is no longer in focus. For more information, see the Out of Focus Messages (OOF) chapter in the AMPS User Guide.

Header Fields

The following table contains the header fields returned in an oof message:

Field

Description

Command

Type of message.

Always oof, as encoded by the protocol.

Topic

The topic which contained the message that has gone out of focus.

SowKey

An AMPS-created identifier for the message that has gone out of focus.

Reason

The reason the message has gone out of focus.

Valid reasons include deleted, expired, match, and entitlement.

SubIds

The subscription IDs of the subscriptions that produced this message.

The AMPS clients will provide this message to the handler registered for each of the subscriptions specified.

CorrelationId

A user-provided string that will be passed, verbatim, to subscribers.

If this header is not present on the SOW record that was deleted, subscribers receive no value for the CorrelationId.

The contents of this header must consist of characters that are legal in Base64 encoding.

Reason

The reason field of the oof message explains why the message no longer matches the subscription. Possible values are:

ReasonDescription

deleted

The message was deleted.

expired

The message expired.

match

The message no longer matches the filter for the subscription or (for paginated subscriptions) no longer matches the pagination window.

entitlement

The access to the messaged changed, such that the user no longer has permission to receive the message.

Data

The oof message contains the updated message that caused the message to go out of focus, except if the reason is entitlement.

Last updated

Copyright 2013-2024 60East Technologies, Inc.