blob: b37f98391c2696ea81b75e43b1339f2b8adc5099 (
plain) (
tree)
|
|
/*******************************************************************************
* Copyright (c) 2011 protos software gmbh (http://www.protos.de).
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* CONTRIBUTORS:
* Thomas Schuetz (initial contribution)
*
*******************************************************************************/
#ifndef _ETMESSAGESERVICE_H_
#define _ETMESSAGESERVICE_H_
#include <stddef.h>
#include "etDatatypes.h"
#include "messaging/etMessageQueue.h"
#include "messaging/etMessageReceiver.h"
#include "osal/etMutex.h"
#include "osal/etThread.h"
#include "osal/etSema.h"
enum etMessageService_execmode {
EXECMODE_POLLED, EXECMODE_BLOCKED, EXECMODE_MIXED
};
typedef struct etBuffer{
etUInt8 *buffer; /** buffer points to the actual memory position for the message pool */
etUInt16 maxBlocks; /** number of blocks for the message pool */
etUInt16 blockSize; /** size of blocks for the message pool */
} etBuffer;
typedef struct etMessageService {
etMessageQueue messageQueue; /** message queue that holds all used messages */
etMessageQueue messagePool; /** message pool that holds all free messages */
etBuffer messageBuffer; /** information about the message buffer that holds information about the actual memory position and size for the message pool */
etDispatcherReceiveMessage msgDispatcher; /** function pointer to the generated message dispatcher function */
etDispatcherExecute executeFct; /** function pointer to the generated message execute function */
etThread thread; /** thread for the execution of the message service */
etMutex poolMutex; /** mutex for synchronizing the access to the message pool */
etMutex queueMutex; /** mutex for synchronizing the access to the message queue */
etSema executionSemaphore; /** sempahore for waiting and waking up the execution */
enum etMessageService_execmode execmode; /** execution mode*/
} etMessageService;
/* lifecycle functions to startup, execute and shutdown the message service */
void etMessageService_init(etMessageService* self, etUInt8* buffer, etUInt16 maxBlocks, etUInt16 blockSize, etDispatcherReceiveMessage msgDispatcher, etDispatcherExecute executeFct, enum etMessageService_execmode execmode);
void etMessageService_start(etMessageService* self);
void etMessageService_execute(etMessageService* self);
void etMessageService_stop(etMessageService* self);
void etMessageService_destroy(etMessageService* self);
/* initialization of message pool */
void etMessageService_initMessagePool(etMessageService* self);
/* message queue interface for push and pop messages */
void etMessageService_pushMessage(etMessageService* self, etMessage* msg);
etMessage* etMessageService_popMessage(etMessageService* self);
/* message pool interface to get and return (push and pop) messages */
etMessage* etMessageService_getMessageBuffer(etMessageService* self, etUInt16 size);
void etMessageService_returnMessageBuffer(etMessageService* self, etMessage* buffer);
/* functions for debug and service information */
etInt16 etMessageService_getMessagePoolLowWaterMark(etMessageService* self);
#endif /* RMESSAGESERVICE_H_ */
|
