epicsMessageQueue.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2002 The University of Chicago, as Operator of Argonne
* National Laboratory.
* Copyright (c) 2002 The Regents of the University of California, as
* Operator of Los Alamos National Laboratory.
* SPDX-License-Identifier: EPICS
* EPICS Base is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/

#ifndef epicsMessageQueueh
#define epicsMessageQueueh

#include "epicsAssert.h"
#include "libComAPI.h"

typedef struct epicsMessageQueueOSD *epicsMessageQueueId;

#ifdef __cplusplus

class LIBCOM_API epicsMessageQueue {
public:

 epicsMessageQueue ( unsigned int capacity,
 unsigned int maximumMessageSize );

 ~epicsMessageQueue ();

 int trySend ( void *message, unsigned int messageSize );

 int send ( void *message, unsigned int messageSize );

 int send ( void *message, unsigned int messageSize, double timeout );

 int tryReceive ( void *message, unsigned int size );

 int receive ( void *message, unsigned int size );

 int receive ( void *message, unsigned int size, double timeout );

 void show ( unsigned int level = 0 );

 unsigned int pending ();

private:
 epicsMessageQueue();
 epicsMessageQueue(const epicsMessageQueue &);
 epicsMessageQueue& operator=(const epicsMessageQueue &);

 epicsMessageQueueId id;
};

extern "C" {
#endif /*__cplusplus */

LIBCOM_API epicsMessageQueueId epicsStdCall epicsMessageQueueCreate(
 unsigned int capacity,
 unsigned int maximumMessageSize);

LIBCOM_API void epicsStdCall epicsMessageQueueDestroy(
 epicsMessageQueueId id);

LIBCOM_API int epicsStdCall epicsMessageQueueTrySend(
 epicsMessageQueueId id,
 void *message,
 unsigned int messageSize);

LIBCOM_API int epicsStdCall epicsMessageQueueSend(
 epicsMessageQueueId id,
 void *message,
 unsigned int messageSize);

LIBCOM_API int epicsStdCall epicsMessageQueueSendWithTimeout(
 epicsMessageQueueId id,
 void *message,
 unsigned int messageSize,
 double timeout);

LIBCOM_API int epicsStdCall epicsMessageQueueTryReceive(
 epicsMessageQueueId id,
 void *message,
 unsigned int size);

LIBCOM_API int epicsStdCall epicsMessageQueueReceive(
 epicsMessageQueueId id,
 void *message,
 unsigned int size);

LIBCOM_API int epicsStdCall epicsMessageQueueReceiveWithTimeout(
 epicsMessageQueueId id,
 void *message,
 unsigned int size,
 double timeout);

LIBCOM_API int epicsStdCall epicsMessageQueuePending(
 epicsMessageQueueId id);

LIBCOM_API void epicsStdCall epicsMessageQueueShow(
 epicsMessageQueueId id,
 int level);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#include "osdMessageQueue.h"

#endif /* epicsMessageQueueh */