msg_receive

Function • Params and return types changed in PHP 8.0

Receive a message from a message queue.

PHP 5

PHP 7

PHP 8.0

Improved

PHP 8.1

PHP 8.2-8.3

PHP 8.4

PHP 8.5

PHP 8.6

`msg_receive` Function synopsis

msg_receive(
    SysvMessageQueue $queue,
    int $desired_message_type,
    &$received_message_type,
    int $max_message_size,
    mixed &$message,
    bool $unserialize = true,
    int $flags = 0,
    &$error_code = null
  ): bool

Parameters

`$queue`

TypeSysvMessageQueue

`$desired_message_type`

Typeint

`$received_message_type`

Passed by reference

`$max_message_size`

Typeint

`$message`

Passed by referenceTypemixed

`$unserialize`

OptionalTypeboolDefault valuetrue

`$flags`

OptionalTypeintDefault value0

The optional $flags allows you to pass flags to the low-level msgrcv system call. It defaults to 0, but you may specify one or more of the following values (by adding or ORing them together).

$flags accepts one or a bitmask of the following constant values:

`$error_code`

Passed by reference, OptionalDefault valuenull

Note that the parameters $received_message_type, $message, and $error_code are passed by reference, and contain additional/updated context data that may be useful.

Return value

Typebool

Changes to the `msg_receive` Function

PHP 8.0

Return type added: bool
Parameter type added for parameter #1 ($queue): SysvMessageQueue
Parameter name of parameter #2 changed: $desiredmsgtype to $desired_message_type
Parameter type added for parameter #2 ($desired_message_type): int
Parameter name of parameter #3 changed: $msgtype to $received_message_type
Parameter name of parameter #4 changed: $maxsize to $max_message_size
Parameter type added for parameter #4 ($max_message_size): int
Parameter type added for parameter #5 ($message): mixed
Parameter type added for parameter #6 ($unserialize): bool
Parameter default value added for position #6 ($unserialize): true
Parameter type added for parameter #7 ($flags): int
Parameter default value added for position #7 ($flags): 0
Parameter name of parameter #8 changed: $errorcode to $error_code
Parameter default value added for position #8 ($error_code): null

  msg_receive(
-     $queue,
+     SysvMessageQueue $queue,
-     $desiredmsgtype,
+     int $desired_message_type,
-     &$msgtype,
+     &$received_message_type,
-     $maxsize,
+     int $max_message_size,
-     &$message,
+     mixed &$message,
-     $unserialize,
+     bool $unserialize = true,
-     $flags,
+     int $flags = 0,
-     &$errorcode
+     &$error_code = null
-   )
+   ): bool

`msg_receive` Function Availability

PHP Version	Availability
PHP 8.6Upcoming Release	Yes
PHP 8.5Supported (Latest)	Yes
PHP 8.4Supported	Yes
PHP 8.3Security-Fixes Only	Yes
PHP 8.2Security-Fixes Only	Yes
PHP 8.1Unsupported	Yes
PHP 8.0Unsupported	Yes
PHP 7.4Unsupported	Yes
PHP 7.3Unsupported	Yes
PHP 7.2Unsupported	Yes
PHP 7.1Unsupported	Yes
PHP 7.0Unsupported	Yes
PHP 5.6Unsupported	Yes
PHP 5.5Unsupported	Yes
PHP 5.4Unsupported	Yes
PHP 5.3Unsupported	Yes

msg_receive Function synopsis

msg_receive Function Availability

`msg_receive` Function synopsis

`msg_receive` Function Availability