bcs_ipcqueue.h

Go to the documentation of this file.

/*
* Copyright (c) 2008-2011 Marius Zwicker / Elefant Racing Bayreuth. 
* All rights reserved.
*
* @ERB_OPEN_LICENSE_HEADER_START@
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* 
*     http://www.apache.org/licenses/LICENSE-2.0
* 
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*      http://www.elefantracing.de
*
* @ERB_OPEN_LICENSE_HEADER_END@
*/

#ifndef BCS_IPCQUEUE_H_
#define BCS_IPCQUEUE_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "bcs_general.h"
       
#define BCS_Q_MAXSIZE 4000

#ifndef BCS_Q_FLAG_ENUM
#define BCS_Q_FLAG_ENUM

typedef enum {
       BCS_Q_NONE, 
       BCS_Q_NOWAIT 
} BCS_Q_Flag;
#endif
       
#define BCS_Q_getQueue(q, id, datatype ) _BCS_Q_getQueue(q, id, sizeof(datatype))

/*
 * Please do not use this
 */
BCS_ERROR _BCS_Q_getQueue(BCS_Queue* q, UInt32 id, UInt16 msg_size);

BCS_ERROR BCS_Q_deleteQueue(BCS_Queue* q);
       

BCS_ERROR BCS_Q_forceUnlock(UInt32 id);

BCS_ERROR BCS_Q_postMessage(BCS_Queue* q, void* m, BCS_Q_Flag f);

BCS_ERROR BCS_Q_getMessage(BCS_Queue* q, void* m, Int32 id, BCS_Q_Flag f);


#ifdef __cplusplus
}
#endif

#ifdef USE_POSIX_QUEUE
/* Says that ipc queue was compiled using the posix implemenetation*/
#define IPCQUEUE_HAS_POSIX
#endif

#endif /* BCS_IPCQUEUE_H_ */