sl@0: /* Copyright (c) 2009 The Khronos Group Inc.
sl@0:  * Portions copyright (c) 2009-2010  Nokia Corporation and/or its subsidiary(-ies)
sl@0:  *
sl@0:  * Permission is hereby granted, free of charge, to any person obtaining a
sl@0:  * copy of this software and/or associated documentation files (the
sl@0:  * "Materials"), to deal in the Materials without restriction, including
sl@0:  * without limitation the rights to use, copy, modify, merge, publish,
sl@0:  * distribute, sublicense, and/or sell copies of the Materials, and to
sl@0:  * permit persons to whom the Materials are furnished to do so, subject to
sl@0:  * the following conditions:
sl@0:  *
sl@0:  * The above copyright notice and this permission notice shall be included
sl@0:  * in all copies or substantial portions of the Materials.
sl@0:  *
sl@0:  * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
sl@0:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
sl@0:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
sl@0:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
sl@0:  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
sl@0:  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
sl@0:  * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
sl@0:  */
sl@0: 
sl@0: #ifndef OWF_MESSAGEQUEUE_H_
sl@0: #define OWF_MESSAGEQUEUE_H_
sl@0: 
sl@0: #include "owftypes.h"
sl@0: #include "owfsemaphore.h"
sl@0: #include "owfmutex.h"
sl@0: 
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: extern "C" {
sl@0: #endif
sl@0: 
sl@0: #define WAIT_FOREVER            -1
sl@0: #define MSG_QUEUE_WAIT_MSG_FETCHED      0
sl@0: #define MSG_QUEUE_WAIT_MSG_ERR          -1
sl@0: #define MSG_QUEUE_WAIT_MSG_TIMEDOUT     -2
sl@0: #define MSG_QUEUE_INIT_OK               0
sl@0: #define MSG_QUEUE_INIT_ERR              -1
sl@0: 
sl@0: 
sl@0: typedef struct {
sl@0:     OWFuint                 id;
sl@0:     void*                   data;
sl@0: } OWF_MESSAGE;
sl@0: 
sl@0: typedef struct _MSGQUE {
sl@0:     void*                   queuePtr;
sl@0: } OWF_MESSAGE_QUEUE;
sl@0: 
sl@0: /*
sl@0:  *  Destroy message queue
sl@0:  *
sl@0:  *  \param queue Message queue to destroy
sl@0:  */
sl@0: OWF_API_CALL void
sl@0: OWF_MessageQueue_Destroy(OWF_MESSAGE_QUEUE* queue);
sl@0: 
sl@0: /*
sl@0:  *  Initialize message queue
sl@0:  *
sl@0:  *  \param queue Message queue to initialize
sl@0:  *  \return 0 if initialization succeeded, < 0 otherwise
sl@0:  *
sl@0:  */
sl@0: OWF_API_CALL OWFint
sl@0: OWF_MessageQueue_Init(OWF_MESSAGE_QUEUE* queue);
sl@0: 
sl@0: /*
sl@0:  *  Insert message into message queue (send it to
sl@0:  *  THE other side)
sl@0:  *
sl@0:  *  \param queue Message queue
sl@0:  *  \param msg Message to send
sl@0:  *  \param data Message contents
sl@0:  *
sl@0:  */
sl@0: OWF_API_CALL void
sl@0: OWF_Message_Send(OWF_MESSAGE_QUEUE* queue,
sl@0:                  OWFuint msg,
sl@0:                  void* data);
sl@0: /*
sl@0:  *  Wait for message
sl@0:  *
sl@0:  *  \param queue Message queue
sl@0:  *  \param msg Where to store the received message
sl@0:  *  \param timeout Time to wait for the message (microseconds)
sl@0:  *
sl@0:  *  \return < 0 if error occurred, 0 if no message was received within
sl@0:  *  given period of time, > 0 otherwise; received message is stored into
sl@0:  *  OWF_MESSAGE structure pointed by the msg param
sl@0:  *
sl@0:  */
sl@0: OWF_API_CALL OWFint
sl@0: OWF_Message_Wait(OWF_MESSAGE_QUEUE* queue,
sl@0:                  OWF_MESSAGE* msg,
sl@0:                  OWFint timeout);
sl@0: 
sl@0: 
sl@0: #ifdef __cplusplus
sl@0: }
sl@0: #endif
sl@0: 
sl@0: 
sl@0: #endif