annotate PrivateQueue.h @ 44:67c7f5a0308b

Renamed VMS to PR, in new branch
author Sean Halle <seanhalle@yahoo.com>
date Fri, 08 Mar 2013 05:40:08 -0800
parents d01d48b023ca
children 8c0dcf6e15e6
rev   line source
Me@19 1 /*
seanhalle@44 2 * Copyright 2009 OpenSourceResearchInstitute.org
Me@19 3 * Licensed under GNU General Public License version 2
Me@19 4 *
Me@19 5 * Author: seanhalle@yahoo.com
Me@19 6 */
Me@19 7
Me@19 8 #ifndef _PRIVATE_QUEUE_H
Me@19 9 #define _PRIVATE_QUEUE_H
Me@19 10
Me@20 11
seanhalle@43 12 #include "PR_impl/PR_primitive_data_types.h"
seanhalle@43 13 #include "PR_impl/Services_Offered_by_PR/Memory_Handling/vmalloc.h"
Me@20 14
Me@19 15
Me@19 16 #define TRUE 1
Me@19 17 #define FALSE 0
Me@19 18
Me@19 19 #define LOCKED 1
Me@19 20 #define UNLOCKED 0
Me@19 21
Me@19 22
Me@19 23 /* It is the data that is shared so only need one mutex. */
Me@19 24 typedef struct
Me@19 25 { void **insertPos;
Me@19 26 void **extractPos;
Me@19 27 void **startOfData; //data is pointers
Me@19 28 void **endOfData; //set when alloc data
Me@19 29 }
Me@19 30 PrivQueueStruc;
Me@19 31
seanhalle@30 32 typedef void (*DynArrayFnPtr) ( void * ); //fn has to cast void *
Me@19 33
Me@19 34 PrivQueueStruc* makePrivQ ( );
seanhalle@37 35 bool32 isEmptyPrivQ ( PrivQueueStruc *Q ); //ret TRUE if empty
seanhalle@37 36 void* peekPrivQ ( PrivQueueStruc *Q ); //ret NULL if empty
seanhalle@32 37 void* readPrivQ ( PrivQueueStruc *Q ); //ret NULL if empty
Me@19 38 void writePrivQ( void *in, PrivQueueStruc *Q );
seanhalle@32 39 //return false when full
seanhalle@32 40 bool32 writeIfSpacePrivQ( void * in, PrivQueueStruc* Q );
seanhalle@32 41 int32 numInPrivQ( PrivQueueStruc *Q );
seanhalle@32 42 void pushPrivQ( void * in, PrivQueueStruc* Q );
seanhalle@32 43 void freePrivQ( PrivQueueStruc *Q );
seanhalle@30 44
Me@19 45 #endif /* _PRIVATE_QUEUE_H */
Me@19 46