os/ossrv/genericopenlibs/openenvcore/backend/inc/tsignalmessage.h
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
// Signal data structure that supports marshalling
sl@0
    15
// 
sl@0
    16
//
sl@0
    17
sl@0
    18
#include <e32base.h>
sl@0
    19
sl@0
    20
#ifndef TSIGNALMESSAGE_H
sl@0
    21
#define TSIGNALMESSAGE_H
sl@0
    22
sl@0
    23
const TInt KSigMsgLength = 32;
sl@0
    24
const TUint8 KSigMsgVersion = 1;
sl@0
    25
sl@0
    26
/*
sl@0
    27
@internalComponent
sl@0
    28
*/
sl@0
    29
class TSignalMessage
sl@0
    30
	{
sl@0
    31
public:
sl@0
    32
	TUint8	mType;
sl@0
    33
	union
sl@0
    34
		{
sl@0
    35
		struct
sl@0
    36
			{
sl@0
    37
			TUint8	mSignal;
sl@0
    38
			TUint32	mValue;
sl@0
    39
			} mSigVal;
sl@0
    40
		struct
sl@0
    41
			{
sl@0
    42
			TUint8 	mSignal;	
sl@0
    43
			TInt32	mTimerId;
sl@0
    44
			} mRtSignal;
sl@0
    45
		TUint8 	mSignal;		
sl@0
    46
		TUint32 mTimeOut;
sl@0
    47
		TUint32 mData;
sl@0
    48
		TUint64	mPid;
sl@0
    49
		};
sl@0
    50
sl@0
    51
	enum {
sl@0
    52
		ESignal = 0,
sl@0
    53
		ESignalValuePair,
sl@0
    54
		EAlarmRegistration,
sl@0
    55
		EDequeueSignal,
sl@0
    56
		EWaitOnChild,
sl@0
    57
		ERtTimerSignal,
sl@0
    58
	} TSignalMessageType;
sl@0
    59
sl@0
    60
	virtual ~TSignalMessage() {}
sl@0
    61
sl@0
    62
	static TBool SignalMatchBySigNum(const TSignalMessage& aMsg1, const TSignalMessage& aMsg2)
sl@0
    63
		{
sl@0
    64
		if(aMsg1.mType != ESignal || aMsg2.mType != ESignal)
sl@0
    65
			return EFalse;
sl@0
    66
sl@0
    67
		if (aMsg1.mSignal == aMsg2.mSignal)
sl@0
    68
			{
sl@0
    69
			return ETrue;
sl@0
    70
			}
sl@0
    71
		return EFalse;
sl@0
    72
		}
sl@0
    73
sl@0
    74
	static TBool SigValMatchBySigNum(const TSignalMessage& aMsg1, const TSignalMessage& aMsg2)
sl@0
    75
		{
sl@0
    76
		if(aMsg1.mType != ESignalValuePair || aMsg2.mType != ESignalValuePair)
sl@0
    77
			return EFalse;
sl@0
    78
sl@0
    79
		if (aMsg1.mSigVal.mSignal == aMsg2.mSigVal.mSignal)
sl@0
    80
			{
sl@0
    81
			return ETrue;
sl@0
    82
			}
sl@0
    83
		return EFalse;
sl@0
    84
		}
sl@0
    85
sl@0
    86
	inline TInt Marshall(TDes8& aBuffer)
sl@0
    87
		{
sl@0
    88
		TUint8	lBufPtr[KSigMsgLength] = {0};
sl@0
    89
sl@0
    90
		if(aBuffer.MaxSize() != KSigMsgLength)
sl@0
    91
			return KErrArgument;
sl@0
    92
sl@0
    93
		lBufPtr[0] = KSigMsgVersion;
sl@0
    94
		lBufPtr[1] = mType;
sl@0
    95
sl@0
    96
		switch(mType)
sl@0
    97
			{
sl@0
    98
			case ESignal:
sl@0
    99
				lBufPtr[2] = mSignal;
sl@0
   100
				break;
sl@0
   101
			case ESignalValuePair:
sl@0
   102
				lBufPtr[2] = mSigVal.mSignal;
sl@0
   103
sl@0
   104
				lBufPtr[3] = (TUint8)(mSigVal.mValue & 0x000000FF);
sl@0
   105
				lBufPtr[4] = (TUint8)((mSigVal.mValue & 0x0000FF00) >> 8);
sl@0
   106
				lBufPtr[5] = (TUint8)((mSigVal.mValue & 0x00FF0000) >> 16);
sl@0
   107
				lBufPtr[6] = (TUint8)((mSigVal.mValue & 0xFF000000) >> 24);
sl@0
   108
				break;
sl@0
   109
			case EAlarmRegistration:
sl@0
   110
				lBufPtr[2] = (TUint8)(mTimeOut & 0x000000FF);
sl@0
   111
				lBufPtr[3] = (TUint8)((mTimeOut & 0x0000FF00) >> 8);
sl@0
   112
				lBufPtr[4] = (TUint8)((mTimeOut & 0x00FF0000) >> 16);
sl@0
   113
				lBufPtr[5] = (TUint8)((mTimeOut & 0xFF000000) >> 24);
sl@0
   114
				break;
sl@0
   115
			case EDequeueSignal:
sl@0
   116
				lBufPtr[2] = mSignal;
sl@0
   117
				break;
sl@0
   118
			case EWaitOnChild:
sl@0
   119
				memcpy(&lBufPtr[2],&mPid,sizeof(mPid));
sl@0
   120
				break;
sl@0
   121
			case ERtTimerSignal:
sl@0
   122
				Mem::Copy(&lBufPtr[2], &mRtSignal.mSignal, sizeof(mRtSignal.mSignal));
sl@0
   123
				Mem::Copy(&lBufPtr[2+sizeof(mRtSignal.mSignal)], &mRtSignal.mTimerId, sizeof(mRtSignal.mTimerId));
sl@0
   124
				break;
sl@0
   125
			default:
sl@0
   126
				// do nothing
sl@0
   127
				return KErrGeneral;
sl@0
   128
				break;
sl@0
   129
			}
sl@0
   130
		aBuffer.Zero();
sl@0
   131
		aBuffer.Append(lBufPtr,KSigMsgLength);
sl@0
   132
		return KErrNone;
sl@0
   133
		}
sl@0
   134
sl@0
   135
	inline TInt Unmarshall(TDes8& aBuffer)
sl@0
   136
		{
sl@0
   137
		const TUint8* lBufPtr = aBuffer.Ptr();
sl@0
   138
sl@0
   139
		if(aBuffer.MaxSize() != KSigMsgLength)
sl@0
   140
			return KErrArgument;
sl@0
   141
sl@0
   142
		if(lBufPtr[0] != KSigMsgVersion)
sl@0
   143
			return KErrGeneral;
sl@0
   144
sl@0
   145
		mType = lBufPtr[1];
sl@0
   146
sl@0
   147
		switch(mType)
sl@0
   148
			{
sl@0
   149
			case ESignal:
sl@0
   150
				mSignal = lBufPtr[2];
sl@0
   151
				break;
sl@0
   152
			case ESignalValuePair:
sl@0
   153
				mSigVal.mSignal = lBufPtr[2];
sl@0
   154
				mSigVal.mValue = 0;
sl@0
   155
				mSigVal.mValue |= (TUint32)lBufPtr[3];
sl@0
   156
				mSigVal.mValue |= (((TUint32)lBufPtr[4]) << 8);
sl@0
   157
				mSigVal.mValue |= (((TUint32)lBufPtr[5]) << 16);
sl@0
   158
				mSigVal.mValue |= (((TUint32)lBufPtr[6]) << 24);
sl@0
   159
				break;
sl@0
   160
			case EAlarmRegistration:
sl@0
   161
				mTimeOut = 0;
sl@0
   162
				mTimeOut |= (TUint32)lBufPtr[2];
sl@0
   163
				mTimeOut |= (((TUint32)lBufPtr[3]) << 8);
sl@0
   164
				mTimeOut |= (((TUint32)lBufPtr[4]) << 16);
sl@0
   165
				mTimeOut |= (((TUint32)lBufPtr[5]) << 24);
sl@0
   166
				break;
sl@0
   167
			case EDequeueSignal:
sl@0
   168
				mSignal = lBufPtr[2];
sl@0
   169
				break;
sl@0
   170
			case EWaitOnChild:
sl@0
   171
				mPid = 0;
sl@0
   172
				memcpy(&mPid,&lBufPtr[2],sizeof(mPid));
sl@0
   173
				break;
sl@0
   174
			case ERtTimerSignal:
sl@0
   175
				Mem::Copy(&mRtSignal.mSignal, &lBufPtr[2], sizeof(mRtSignal.mSignal));
sl@0
   176
				Mem::Copy(&mRtSignal.mTimerId,&lBufPtr[2+sizeof(mRtSignal.mSignal)], sizeof(mRtSignal.mTimerId));
sl@0
   177
				break;
sl@0
   178
			default:
sl@0
   179
				// do nothing
sl@0
   180
				return KErrGeneral;
sl@0
   181
				break;
sl@0
   182
			}
sl@0
   183
sl@0
   184
		return KErrNone;
sl@0
   185
		}
sl@0
   186
	};
sl@0
   187
sl@0
   188
#endif // TSIGNALMESSAGE_H