IMessageProxy
in
This interface is a requirement for any class that acts as a message proxy, provided as an argument to CSMessageQueue::displatchMessageWithId.
It provides the general implementation / interface of message records.
Tags
Table of Contents
- acknowledge() : void
- This method gets called when a message has been acknowledged (processed successfully)
- decline() : void
- This method gets called when a message has been declined.
- fail() : void
- This method gets called when a message has failed.
- ignore() : void
- This method gets called when a message has been ignored by a target
- logMessage() : void
- This method is called when a message is to be logged.
Methods
acknowledge()
This method gets called when a message has been acknowledged (processed successfully)
public
acknowledge(int $iMessageId) : void
Parameters
- $iMessageId : int
-
The id of the message that has been acknowledged
Tags
Return values
void —decline()
This method gets called when a message has been declined.
public
decline(int $iMessageId) : void
Parameters
- $iMessageId : int
-
The id of the message that has been declined
Tags
Return values
void —fail()
This method gets called when a message has failed.
public
fail(int $iMessageId) : void
Parameters
- $iMessageId : int
-
The id of the message that failed
Tags
Return values
void —ignore()
This method gets called when a message has been ignored by a target
public
ignore(int $iMessageId) : void
Parameters
- $iMessageId : int
-
The id of the message that has been ignored
Tags
Return values
void —logMessage()
This method is called when a message is to be logged.
public
logMessage(string $sMessage[, int $iType = CSMessageConst::LOG_TYPE_INFO ]) : void
Parameters
- $sMessage : string
-
The message to be logged
- $iType : int = CSMessageConst::LOG_TYPE_INFO
-
The message type as one of the CSMessageConst::LOG_TYPE_* constants