pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
plank_LockFreeLinkedListElement.h
00001 /*
00002  -------------------------------------------------------------------------------
00003  This file is part of the Plink, Plonk, Plank libraries
00004   by Martin Robinson
00005  
00006  http://code.google.com/p/pl-nk/
00007  
00008  Copyright University of the West of England, Bristol 2011-14
00009  All rights reserved.
00010  
00011  Redistribution and use in source and binary forms, with or without
00012  modification, are permitted provided that the following conditions are met:
00013  
00014  * Redistributions of source code must retain the above copyright
00015    notice, this list of conditions and the following disclaimer.
00016  * Redistributions in binary form must reproduce the above copyright
00017    notice, this list of conditions and the following disclaimer in the
00018    documentation and/or other materials provided with the distribution.
00019  * Neither the name of University of the West of England, Bristol nor 
00020    the names of its contributors may be used to endorse or promote products
00021    derived from this software without specific prior written permission.
00022  
00023  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
00024  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00025  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
00026  DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
00027  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
00028  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
00029  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
00030  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
00031  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
00032  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
00033  
00034  This software makes use of third party libraries. For more information see:
00035  doc/license.txt included in the distribution.
00036  -------------------------------------------------------------------------------
00037  */
00038 
00039 #ifndef PLANK_LOCKFREELINKEDLISTELEMENT_H
00040 #define PLANK_LOCKFREELINKEDLISTELEMENT_H
00041 
00042 #include "atomic/plank_Atomic.h"
00043 
00044 PLANK_BEGIN_C_LINKAGE
00045 
00057 typedef struct PlankLockFreeLinkedListElement*   PlankLockFreeLinkedListElementRef;
00058 typedef PlankLockFreeLinkedListElementRef PlankLockFreeQueueElementRef;
00059 typedef PlankLockFreeLinkedListElementRef PlankLockFreeStackElementRef;
00060 
00061 PlankLockFreeLinkedListElementRef pl_LockFreeLinkedListElement_CreateAndInit();
00062 PlankLockFreeLinkedListElementRef pl_LockFreeLinkedListElement_Create();
00063 PlankResult pl_LockFreeLinkedListElement_Init (PlankLockFreeLinkedListElementRef p);
00064 PlankResult pl_LockFreeLinkedListElement_DeInit (PlankLockFreeLinkedListElementRef p);
00065 PlankResult pl_LockFreeLinkedListElement_Destroy (PlankLockFreeLinkedListElementRef p);
00066 PlankP pl_LockFreeLinkedListElement_GetData (PlankLockFreeLinkedListElementRef p);
00067 void pl_LockFreeLinkedListElement_SetData (PlankLockFreeLinkedListElementRef p, const PlankP data);
00068 PlankLockFreeLinkedListElementRef pl_LockFreeLinkedListElement_GetNext (PlankLockFreeLinkedListElementRef p);
00069 void pl_LockFreeLinkedListElement_SetNext (PlankLockFreeLinkedListElementRef p, const PlankLockFreeLinkedListElementRef next);
00070 
00071 PlankAtomicPXRef pl_LockFreeLinkedListElement_GetDataAtom (PlankLockFreeLinkedListElementRef p);
00072 PlankAtomicPXRef pl_LockFreeLinkedListElement_GetNextAtom (PlankLockFreeLinkedListElementRef p);
00073 
00076 PLANK_END_C_LINKAGE
00077 
00078 #define PLANK_INLINING_FUNCTIONS 1
00079 #include "plank_LockFreeLinkedListElementInline.h"
00080 #undef PLANK_INLINING_FUNCTIONS
00081 
00082 // make these inline at some point..
00083 
00084 #define pl_LockFreeQueueElement_CreateAndInit  pl_LockFreeLinkedListElement_CreateAndInit
00085 #define pl_LockFreeQueueElement_Create  pl_LockFreeLinkedListElement_Create
00086 #define pl_LockFreeQueueElement_Init  pl_LockFreeLinkedListElement_Init
00087 #define pl_LockFreeQueueElement_DeInit  pl_LockFreeLinkedListElement_DeInit
00088 #define pl_LockFreeQueueElement_Destroy pl_LockFreeLinkedListElement_Destroy
00089 #define pl_LockFreeQueueElement_GetData pl_LockFreeLinkedListElement_GetData
00090 #define pl_LockFreeQueueElement_SetData pl_LockFreeLinkedListElement_SetData
00091 #define pl_LockFreeQueueElement_GetNext pl_LockFreeLinkedListElement_GetNext
00092 #define pl_LockFreeQueueElement_SetNext pl_LockFreeLinkedListElement_SetNext
00093 #define pl_LockFreeQueueElement_GetDataAtom pl_LockFreeLinkedListElement_GetDataAtom
00094 #define pl_LockFreeQueueElement_GetNextAtom pl_LockFreeLinkedListElement_GetNextAtom
00095 
00096 #define pl_LockFreeStackElement_CreateAndInit  pl_LockFreeLinkedListElement_CreateAndInit
00097 #define pl_LockFreeStackElement_Create  pl_LockFreeLinkedListElement_Create
00098 #define pl_LockFreeStackElement_Init  pl_LockFreeLinkedListElement_Init
00099 #define pl_LockFreeStackElement_DeInit  pl_LockFreeLinkedListElement_DeInit
00100 #define pl_LockFreeStackElement_Destroy pl_LockFreeLinkedListElement_Destroy
00101 #define pl_LockFreeStackElement_GetData pl_LockFreeLinkedListElement_GetData
00102 #define pl_LockFreeStackElement_SetData pl_LockFreeLinkedListElement_SetData
00103 #define pl_LockFreeStackElement_GetNext pl_LockFreeLinkedListElement_GetNext
00104 #define pl_LockFreeStackElement_SetNext pl_LockFreeLinkedListElement_SetNext
00105 #define pl_LockFreeStackElement_GetDataAtom pl_LockFreeLinkedListElement_GetDataAtom
00106 #define pl_LockFreeQueueElement_GetNextAtom pl_LockFreeLinkedListElement_GetNextAtom
00107 
00108 #endif // PLANK_LOCKFREELINKEDLISTELEMENT_H
 All Classes Functions Typedefs Enumerations Enumerator Properties