diff --git a/reference/sem/functions/msg-get-queue.xml b/reference/sem/functions/msg-get-queue.xml index 0ec63fc547..40003564c4 100644 --- a/reference/sem/functions/msg-get-queue.xml +++ b/reference/sem/functions/msg-get-queue.xml @@ -1,6 +1,6 @@ - + msg_get_queue Create or attach to a message queue @@ -9,15 +9,15 @@ &reftitle.description; - resourcemsg_get_queue + SysvMessageQueuefalsemsg_get_queue intkey - intperms0666 + intpermissions0666 msg_get_queue returns an id that can be used to access the System V message queue with the given key. The first call creates the message queue with - the optional perms. + the optional permissions. A second call to msg_get_queue for the same key will return a different message queue identifier, but both identifiers access the same underlying message @@ -38,11 +38,11 @@ - perms + permissions Queue permissions. Default to 0666. If the message queue already - exists, the perms will be ignored. + exists, the permissions will be ignored. @@ -53,10 +53,36 @@ &reftitle.returnvalues; - Returns a resource handle that can be used to access the System V message queue. + Returns SysvMessageQueue instance that can be used to access the System V message queue, + &return.falseforfailure;. + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + On success, this function returns a SysvMessageQueue instance now; + previously, a resource was returned. + + + + + + + + &reftitle.seealso; @@ -71,7 +97,6 @@ - - + msg_receive Receive a message from a message queue @@ -10,19 +10,19 @@ &reftitle.description; boolmsg_receive - resourcequeue - intdesiredmsgtype - intmsgtype - intmaxsize + SysvMessageQueuequeue + intdesired_message_type + intreceived_message_type + intmax_message_size mixedmessage boolunserialize&true; intflags0 - interrorcode + interror_code&null; msg_receive will receive the first message from the specified queue of the type specified by - desiredmsgtype. + desired_message_type. @@ -34,20 +34,20 @@ queue - Message queue resource handle + The message queue. - desiredmsgtype + desired_message_type - If desiredmsgtype is 0, the message from the front - of the queue is returned. If desiredmsgtype is + If desired_message_type is 0, the message from the front + of the queue is returned. If desired_message_type is greater than 0, then the first message of that type is returned. - If desiredmsgtype is less than 0, the first + If desired_message_type is less than 0, the first message on the queue with a type less than or equal to the - absolute value of desiredmsgtype will be read. + absolute value of desired_message_type will be read. If no messages match the criteria, your script will wait until a suitable message arrives on the queue. You can prevent the script from blocking by specifying MSG_IPC_NOWAIT in the @@ -56,7 +56,7 @@ - msgtype + received_message_type The type of the message that was received will be stored in this @@ -65,11 +65,11 @@ - maxsize + max_message_size The maximum size of message to be accepted is specified by the - maxsize; if the message in the queue is larger + max_message_size; if the message in the queue is larger than this size the function will fail (unless you set flags as described below). @@ -115,7 +115,7 @@ MSG_IPC_NOWAIT If there are no messages of the - desiredmsgtype, return immediately and do not + desired_message_type, return immediately and do not wait. The function will fail and return an integer value corresponding to MSG_ENOMSG. @@ -123,16 +123,16 @@ MSG_EXCEPT Using this flag in combination with a - desiredmsgtype greater than 0 will cause the + desired_message_type greater than 0 will cause the function to receive the first message that is not equal to - desiredmsgtype. + desired_message_type. MSG_NOERROR - If the message is longer than maxsize, + If the message is longer than max_message_size, setting this flag will truncate the message to - maxsize and will not signal an error. + max_message_size and will not signal an error. @@ -142,10 +142,10 @@ - errorcode + error_code - If the function fails, the optional errorcode + If the function fails, the optional error_code will be set to the value of the system errno variable. @@ -167,6 +167,31 @@ + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + queue expects a SysvMessageQueue + instance now; previously, a resource was expected. + + + + + + + + &reftitle.seealso; @@ -180,7 +205,6 @@ - - + msg_remove_queue Destroy a message queue @@ -10,7 +10,7 @@ &reftitle.description; boolmsg_remove_queue - resourcequeue + SysvMessageQueuequeue msg_remove_queue destroys the message queue specified @@ -28,7 +28,7 @@ queue - Message queue resource handle + The message queue. @@ -43,6 +43,31 @@ + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + queue expects a SysvMessageQueue + instance now; previously, a resource was expected. + + + + + + + + &reftitle.seealso; @@ -56,7 +81,6 @@ - - + msg_send Send a message to a message queue @@ -10,16 +10,16 @@ &reftitle.description; boolmsg_send - resourcequeue - intmsgtype - mixedmessage + SysvMessageQueuequeue + intmessage_type + stringintfloatboolmessage boolserialize&true; boolblocking&true; - interrorcode + interror_code&null; msg_send sends a message of type - msgtype (which MUST be greater than 0) to + message_type (which MUST be greater than 0) to the message queue specified by queue. @@ -32,12 +32,12 @@ queue - Message queue resource handle + The message queue. - msgtype + message_type The type of the message (MUST be greater than 0) @@ -84,14 +84,14 @@ optional blocking parameter to &false;, in which case msg_send will immediately return &false; if the message is too big for the queue, and set the optional - errorcode to MSG_EAGAIN, + error_code to MSG_EAGAIN, indicating that you should try to send your message again a little later on. - errorcode + error_code If the function fails, the optional errorcode will be set to the value of the system errno variable. @@ -115,6 +115,31 @@ + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + queue expects a SysvMessageQueue + instance now; previously, a resource was expected. + + + + + + + + &reftitle.seealso; @@ -128,7 +153,6 @@ - - + msg_set_queue Set information in the message queue data structure @@ -10,7 +10,7 @@ &reftitle.description; boolmsg_set_queue - resourcequeue + SysvMessageQueuequeue arraydata @@ -35,7 +35,7 @@ queue - Message queue resource handle + The message queue. @@ -59,6 +59,31 @@ + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + queue expects a SysvMessageQueue + instance now; previously, a resource was expected. + + + + + + + + &reftitle.seealso; @@ -72,7 +97,6 @@ - - + msg_stat_queue Returns information from the message queue data structure @@ -9,8 +9,8 @@ &reftitle.description; - arraymsg_stat_queue - resourcequeue + arrayfalsemsg_stat_queue + SysvMessageQueuequeue msg_stat_queue returns the message queue meta data @@ -28,7 +28,7 @@ queue - Message queue resource handle + The message queue. @@ -39,7 +39,7 @@ &reftitle.returnvalues; - The return value is an array whose keys and values have the following + On success, the return value is an array whose keys and values have the following meanings: Array structure for msg_stat_queue @@ -111,8 +111,36 @@
+ + Returns &false; on failure. + + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 8.0.0 + + queue expects a SysvMessageQueue + instance now; previously, a resource was expected. + + + + + + + + &reftitle.seealso; @@ -126,7 +154,6 @@ -