examples/PIPS/opencmessagequeuelibraryex/engine/inc/msgqinternal.h

00001 /*
00002 Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
00003 
00004 Redistribution and use in source and binary forms, with or without
00005 modification, are permitted provided that the following conditions are met:
00006 
00007 * Redistributions of source code must retain the above copyright notice, this
00008   list of conditions and the following disclaimer.
00009 * Redistributions in binary form must reproduce the above copyright notice,
00010   this list of conditions and the following disclaimer in the documentation
00011   and/or other materials provided with the distribution.
00012 * Neither the name of Nokia Corporation nor the names of its contributors
00013   may be used to endorse or promote products derived from this software
00014   without specific prior written permission.
00015 
00016 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00017 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00018 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00019 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00020 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00021 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00022 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00023 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00024 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00025 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026 
00027 Description:  
00028 */
00029 
00030 #ifndef MSGQINTERNAL_H
00031 #define MSGQINTERNAL_H
00032 
00033 #include "MsgQLib.h"
00034 
00035 /* data strucure used for maintaining message queues */
00036 
00037 typedef struct MsgQInfo* MSGQ_INFO_PTR;
00038 
00039 typedef struct MsgQInfo {
00040         MSGQ_INFO_PTR    next;        /* next entry in list                  */
00041         ULONG                    qName;       /* queue name                          */
00042         int                              qId;             /* queue id                                    */
00043         int                              semId ;      /* semaphore id                                    */
00044         ULONG                    sendState;       /* message can be sent                 */
00045         ULONG                    numMsgs;     /* number of messages queued           */
00046         ULONG                    maxNumMsgs;  /* maximum number of messages queued   */
00047         struct msqid_ds* slMqInfo_p;  /* msg q info                              */
00048 }MSGQ_INFO;
00049 
00050 
00051 /* Linked List used for maintaining list of all message queues created */
00052 
00053 typedef struct MsgQInfoList* MSGQ_INFO_LIST_PTR;
00054 
00055 typedef struct MsgQInfoList {
00056         MSGQ_INFO_LIST_PTR next;     /* next entry in list */
00057         ULONG               qName;   /* queue name         */
00058 } MSGQ_INFO_LIST;
00059 
00060 /* Forward Declaration of Internal Functions */
00061 int   InstallMsqQTable(ULONG qName, int qId, int semId, int* err);
00062 void  AddToMsgQTable(ULONG qName);
00063 int   RemoveFromMsqQTable(ULONG qName, int* err);
00064 void  DeleteFromMsgQTable(ULONG qName);
00065 MSGQ_INFO* MsgQTableLookup(ULONG qName);
00066 
00067 #endif /* MSGQINTERNAL_H */

Generated by  doxygen 1.6.2