msg_send
(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)
msg_send — Send a message to a message queue
Beschreibung
SysvMessageQueue
$queue
,int
$message_type
,string|int|float|bool
$message
,bool
$serialize
= true
,bool
$blocking
= true
,int
&$error_code
= null
): bool
msg_send() sends a message
of type
message_type
(which MUST be greater than 0) to
the message queue specified by queue
.
Parameter-Liste
-
queue
-
The message queue.
-
message_type
-
The type of the message (MUST be greater than 0)
-
message
-
The body of the message.
Hinweis:
If
serialize
set tofalse
is supplied, MUST be of type: string, int, 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 optionalerror_code
toMSG_EAGAIN
, indicating that you should try to send your message again a little later on. -
error_code
-
If the function fails, the optional errorcode will be set to the value of the system errno variable.
Rückgabewerte
Gibt bei Erfolg true
zurück. Bei einem Fehler wird false
zurückgegeben.
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.
Changelog
Version | Beschreibung |
---|---|
8.0.0 |
queue expects a SysvMessageQueue
instance now; previously, a resource was expected.
|
Siehe auch
- msg_remove_queue() - Entfernt eine Nachrichten-Warteschlange
- msg_receive() - Liest eine Nachricht aus einer Nachrichten-Warteschlange aus
- msg_stat_queue() - Liefert Informationen zur Datenstruktur einer Nachrichten-Warteschlange
- msg_set_queue() - Setzt Metadaten in der Datenstruktur der Nachrichten-Warteschlange