msg_send
(PHP 4 >= 4.3.0, PHP 5, PHP 7)
msg_send — Send a message to a message queue
Description
$queue
, int $msgtype
, mixed $message
[, bool $serialize
= TRUE
[, bool $blocking
= TRUE
[, int &$errorcode
]]] ) : bool
msg_send() sends a message
of type
msgtype
(which MUST be greater than 0) to
the message queue specified by queue
.
Parameters
-
queue
-
Message queue resource handle
-
msgtype
-
The type of the message (MUST be greater than 0)
-
message
-
The body of the message.
Note:
If
serialize
set toFALSE
is supplied, MUST be of type: string, integer, float or bool. In other case a warning will be issued. -
serialize
-
The optional
serialize
controls how themessage
is sent.serialize
defaults toTRUE
which means that themessage
is serialized using the same mechanism as the session module before being sent to the queue. This allows complex arrays and objects to be sent to other PHP scripts, or if you are using the WDDX serializer, to any WDDX compatible client. -
blocking
-
If the message is too large to fit in the queue, your script will wait until another process reads messages from the queue and frees enough space for your message to be sent. This is called blocking; you can prevent blocking by setting the optional
blocking
parameter toFALSE
, in which case msg_send() will immediately returnFALSE
if the message is too big for the queue, and set the optionalerrorcode
toMSG_EAGAIN
, indicating that you should try to send your message again a little later on. -
errorcode
-
If the function fails, the optional errorcode will be set to the value of the system errno variable.
Return Values
Returns TRUE
on success or FALSE
on failure.
Upon successful completion the message queue data structure is updated as
follows: msg_lspid
is set to the process-ID of the
calling process, msg_qnum
is incremented by 1 and
msg_stime
is set to the current time.
See Also
- msg_remove_queue() - Destroy a message queue
- msg_receive() - Receive a message from a message queue
- msg_stat_queue() - Returns information from the message queue data structure
- msg_set_queue() - Set information in the message queue data structure
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-msg-send.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.