Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: c06898f2b842395621ad4f97c7b120fe68b3b8b7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*******************************************************************************
 * 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"
#include "osal/etTimer.h"

#define MESSAGESERVICE_ADDRESS		1
#define BASE_ADDRESS				32

typedef enum etMessageService_execmode {
	EXECMODE_POLLED, EXECMODE_BLOCKED, EXECMODE_MIXED
} etMessageService_execmode;

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 */
	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; 					/** semaphore for waiting and waking up the execution */
	etTimer timer;								/** timer for cyclic calls */
	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,
		etStacksize stacksize,
		etPriority priority,
		etTime interval,
		etDispatcherReceiveMessage msgDispatcher,
		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_ */

Back to the top