Documentation

IronMQ_Message
in package

Table of Contents

MAX_EXPIRES_IN  = 2592000
$body  : mixed
$delay  : mixed
$expires_in  : mixed
$timeout  : mixed
__construct()  : mixed
Create a new message.
asArray()  : mixed
getBody()  : mixed
getDelay()  : mixed
getExpiresIn()  : mixed
getTimeout()  : mixed
setBody()  : mixed
setDelay()  : mixed
setExpiresIn()  : mixed
setTimeout()  : mixed

Constants

Properties

Methods

__construct()

Create a new message.

public __construct(string $message[, array<string|int, mixed> $properties = array() ]) : mixed
Parameters
$message : string

A message body

$properties : array<string|int, mixed> = array()

An array of message properties Fields in $properties array:

  • timeout: Timeout, in seconds. After timeout, item will be placed back on queue. Defaults to 60.
  • delay: The item will not be available on the queue until this many seconds have passed. Defaults to 0.
  • expires_in: How long, in seconds, to keep the item on the queue before it is deleted. Defaults to 604800 (7 days). Maximum is 2592000 (30 days).
Return values
mixed —

asArray()

public asArray() : mixed
Return values
mixed —

getBody()

public getBody() : mixed
Return values
mixed —

getDelay()

public getDelay() : mixed
Return values
mixed —

getExpiresIn()

public getExpiresIn() : mixed
Return values
mixed —

getTimeout()

public getTimeout() : mixed
Return values
mixed —

setBody()

public setBody(mixed $body) : mixed
Parameters
$body : mixed
Return values
mixed —

setDelay()

public setDelay(mixed $delay) : mixed
Parameters
$delay : mixed
Return values
mixed —

setExpiresIn()

public setExpiresIn(mixed $expires_in) : mixed
Parameters
$expires_in : mixed
Return values
mixed —

setTimeout()

public setTimeout(mixed $timeout) : mixed
Parameters
$timeout : mixed
Return values
mixed —

Search results