ProcessDtoAbstract result codes
Constants you pass to $dto->setStopProcess($code, $reason) to tell the platform what to do with the message.
use Hanaboso\PipesPhpSdk\Utils\Process\ProcessDtoAbstract;
Values you set explicitly #
| Constant | Value | Meaning |
|---|---|---|
ProcessDtoAbstract::SUCCESS | 0 | Continue to the next node (you don't normally set this; just return). |
ProcessDtoAbstract::STOP_AND_FAILED | 1006 | Mark the message as failed. After retries are exhausted it lands in Trash. |
ProcessDtoAbstract::DO_NOT_CONTINUE | 1003 | End this branch successfully without flowing further. Useful for filters. |
ProcessDtoAbstract::FORWARD_TO_TARGET_QUEUE | 1002 | Route to a named successor instead of the default one. |
ProcessDtoAbstract::REPEAT | 1001 | Re-deliver this exact message to the same node. Use sparingly. |
Reserved (set by the platform / batch infra) #
| Constant | Value | Meaning |
|---|---|---|
LIMIT_EXCEEDED | 1004 | Limiter held the message back. |
BATCH_CURSOR_WITH_FOLLOWERS | 1010 | A batch node asked for the next page; emit downstream now. |
BATCH_CURSOR_ONLY | 1011 | A batch node asked for the next page; hold downstream until done. |
Failure reporting #
| Constant | Value | Meaning |
|---|---|---|
UNKNOWN_ERROR | 2001 | Generic failure (e.g. uncaught exception). |
INVALID_HEADERS | 2002 | Required headers were missing on inbound message. |
INVALID_CONTENT | 2003 | Message body was not parsable. |
See also #
- ProcessDto
- Building nodes: Error handling and retries
- Node.js equivalent:
ResultCode