Cogent C API and Utilities : Version 6.4
	Inter-Process Communication Functions

`IP_QueueRead`

IP_QueueRead — reads a message from the queue.

Syntax

#include <cogent.h>
int IP_QueueRead( int   qid, 
  void*   msg, 
  int   maxlength);

Arguments

qid: A queue ID.
msg: A buffer to hold the new message.
maxlength: The maximum length in bytes of msg.

Returns

The number of bytes read on success, or -1 on failure and errno is set.

Description

This function reads the next available message from the queue specified by qid. If no message is available, this function returns immediately. If there is insufficient space to hold the entire message then the result is operating-system dependent. (This will change in future releases).

See Also

Cascade QueueServer Functions, IP_QueueWrite


IP_QueueOpen		IP_QueueStrerror

Copyright © 1995-2010 by Cogent Real-Time Systems, Inc. All rights reserved.