MsgRead(), MsgRead_r()

Updated: October 26, 2022

Read data from a message

Synopsis:

#include <sys/neutrino.h>

ssize_t MsgRead( int rcvid, 
                 void* msg, 
                 size_t bytes, 
                 size_t offset );

ssize_t MsgRead_r( int rcvid, 
                   void* msg, 
                   size_t bytes, 
                   size_t offset );

Arguments:

rcvid
The value returned by MsgReceive*() when you received the message.
msg
A pointer to a buffer where the function can store the data.
bytes
The number of bytes that you want to read. This number must not exceed SSIZE_MAX, or the function will behave unpredictably.

These functions don't let you read past the end of the thread's message; they return the number of bytes actually read.

offset
An offset into the thread's send message that indicates where you want to start reading the data.

Library:

libc

Use the -l c option to qcc to link against this library. This library is usually included automatically.

Description:

The MsgRead() and MsgRead_r() kernel calls read data from a message sent by a thread identified by rcvid. The thread being read from must not have been replied to and will be in the REPLY-blocked state. The state of the sending thread doesn't change. Any thread in the receiving process is free to read the message.

These functions are identical except in the way they indicate errors. See the Returns section for details.

If the sending and calling threads are on the same node, the data transfer occurs immediately and the calling thread doesn't block (see “Blocking states,” below).

You'll use these functions in these situations:

When you're finished using MsgRead(), you must use MsgReply*() to ready the REPLY-blocked process and complete the message exchange.

Blocking states

None for the local case. In the network case:

STATE_REPLY
The calling thread is waiting for a network operation to complete. The calling thread is marked as REPLY-blocked on itself (the same process ID as the thread making the call).

Native networking

The MsgRead() function has increased latency when it's used to communicate across a network—a message pass is involved from the server to the network manager (at least). Depending on the size of the data transfer, the server's lsm-qnet.so and the client's lsm-qnet.so may need to communicate over the link to read more data bytes from the client.

Returns:

The only difference between these functions is the way they indicate errors:

MsgRead()
If successful, this function returns the number of bytes read. If an error occurs, it returns -1 and sets errno.
MsgRead_r()
If succesful, this function returns the number of bytes read. If an error occurs, it may return the negative of any value from the Errors section. This function does NOT set errno, even on success.

The bytes copied will be the smaller of the data available on the client side (message size - offset) and the server side (bytes). If the offset is past the end of the client's buffer, this function will copy 0 bytes and return 0.

Errors:

EDEADLK
A deadlock occurred. You can avoid a deadlock by setting the _NTO_CHF_MSG_PAUSING flag when you create a channel; for more information, see ChannelCreate() and MsgPause().
EFAULT
A fault occurred when the kernel tried to access the buffers provided by the client.
ESRCH
The thread indicated by rcvid doesn't exist, is no longer REPLY-blocked on the channel, or the connection was detached.
ESRVRFAULT
A fault occurred in a server's address space when the kernel tried to access the server's message buffers.
ETIMEDOUT
A kernel timeout unblocked the call. See TimerTimeout().

Classification:

QNX Neutrino

Safety:  
Cancellation point No
Interrupt handler No
Signal handler Yes
Thread Yes