bluetooth/btstack/linkmgr/encryptionkeyrefreshhelper.h
author hgs
Wed, 13 Oct 2010 16:20:29 +0300
changeset 51 20ac952a623c
parent 48 22de2e391156
permissions -rw-r--r--
201040_02
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
48
hgs
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     2
// All rights reserved.
hgs
parents:
diff changeset
     3
// This component and the accompanying materials are made available
hgs
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     5
// which accompanies this distribution, and is available
hgs
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     7
//
hgs
parents:
diff changeset
     8
// Initial Contributors:
hgs
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    10
//
hgs
parents:
diff changeset
    11
// Contributors:
hgs
parents:
diff changeset
    12
//
hgs
parents:
diff changeset
    13
// Description:
hgs
parents:
diff changeset
    14
//
hgs
parents:
diff changeset
    15
hgs
parents:
diff changeset
    16
#ifndef ENCRYPTIONKEYREFRESHHELPER_H
hgs
parents:
diff changeset
    17
#define ENCRYPTIONKEYREFRESHHELPER_H
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
#include <bt_sock.h>
hgs
parents:
diff changeset
    21
#include <bluetooth/hci/hciutil.h> 
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
#include "debug.h"
hgs
parents:
diff changeset
    24
#include "linkutil.h"
hgs
parents:
diff changeset
    25
#include "physicallinkhelper.h"
hgs
parents:
diff changeset
    26
#include "physicallinks.h"
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// watchdog 
hgs
parents:
diff changeset
    29
const TUint KTimeoutEncryptionKeyRefresh =   3000000;  // 3 s; 
hgs
parents:
diff changeset
    30
 
hgs
parents:
diff changeset
    31
class TEncryptionKeyRefresherState;
hgs
parents:
diff changeset
    32
class CEncryptionKeyRefresherStateFactory;
hgs
parents:
diff changeset
    33
NONSHARABLE_CLASS(CEncryptionKeyRefresher) : public CPhysicalLinkHelper
hgs
parents:
diff changeset
    34
	{
hgs
parents:
diff changeset
    35
	friend class TEncryptionKeyRefresherState;
hgs
parents:
diff changeset
    36
	friend class TEkrStateIdle;
hgs
parents:
diff changeset
    37
	friend class TEkrStateDisablingLPM;
hgs
parents:
diff changeset
    38
	friend class TEkrStateRefreshingKey;
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
public:
hgs
parents:
diff changeset
    41
	static CEncryptionKeyRefresher* NewL(CPhysicalLinksManager& aLinkMgr, CPhysicalLink& aLink);
hgs
parents:
diff changeset
    42
	~CEncryptionKeyRefresher();
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
	virtual void StartHelper();
hgs
parents:
diff changeset
    45
	
hgs
parents:
diff changeset
    46
	void EncryptionKeyRefreshComplete(TInt aError);
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
private:
hgs
parents:
diff changeset
    49
	CEncryptionKeyRefresher(CPhysicalLinksManager& aLinkMgr, CPhysicalLink& aLink);
hgs
parents:
diff changeset
    50
	void ConstructL(); 
hgs
parents:
diff changeset
    51
	
hgs
parents:
diff changeset
    52
	virtual void TimerExpired();
hgs
parents:
diff changeset
    53
	virtual void HandleError(TInt aError);
hgs
parents:
diff changeset
    54
	virtual void EventReceived(TBTBasebandEventNotification& aEvent);
hgs
parents:
diff changeset
    55
  
hgs
parents:
diff changeset
    56
private:
hgs
parents:
diff changeset
    57
	CEncryptionKeyRefresherStateFactory*	iStateFactory;
hgs
parents:
diff changeset
    58
	const TEncryptionKeyRefresherState*		iState;            
hgs
parents:
diff changeset
    59
	};
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
//--------------------------------------------------
hgs
parents:
diff changeset
    62
// STATE FACTORY
hgs
parents:
diff changeset
    63
//--------------------------------------------------
hgs
parents:
diff changeset
    64
hgs
parents:
diff changeset
    65
/**
hgs
parents:
diff changeset
    66
   Factory for the EncryptionKeyRefresher states
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
   The states are flyweight classes
hgs
parents:
diff changeset
    69
**/
hgs
parents:
diff changeset
    70
NONSHARABLE_CLASS(CEncryptionKeyRefresherStateFactory) : public CBase
hgs
parents:
diff changeset
    71
	{
hgs
parents:
diff changeset
    72
public:
hgs
parents:
diff changeset
    73
	static CEncryptionKeyRefresherStateFactory* NewL();
hgs
parents:
diff changeset
    74
hgs
parents:
diff changeset
    75
	enum TEncryptionKeyRefresherStates
hgs
parents:
diff changeset
    76
		{
hgs
parents:
diff changeset
    77
		EIdle,
hgs
parents:
diff changeset
    78
		EDisablingLPM,
hgs
parents:
diff changeset
    79
		ERefreshingKey,
hgs
parents:
diff changeset
    80
		// Note that we don't need a state to enable LPM again
hgs
parents:
diff changeset
    81
		// as this will happen implicitly when we close our 
hgs
parents:
diff changeset
    82
		// proxy SAP.
hgs
parents:
diff changeset
    83
		// *** keep next one last ***
hgs
parents:
diff changeset
    84
		EEncryptionKeyRefresherMaxState,
hgs
parents:
diff changeset
    85
		};
hgs
parents:
diff changeset
    86
	
hgs
parents:
diff changeset
    87
	const TEncryptionKeyRefresherState& GetState(TEncryptionKeyRefresherStates aState) const;
hgs
parents:
diff changeset
    88
	TInt StateIndex(const TEncryptionKeyRefresherState* aState) const;
hgs
parents:
diff changeset
    89
	
hgs
parents:
diff changeset
    90
private:
hgs
parents:
diff changeset
    91
	CEncryptionKeyRefresherStateFactory();
hgs
parents:
diff changeset
    92
	void ConstructL();
hgs
parents:
diff changeset
    93
	TFixedArray<TEncryptionKeyRefresherState*, EEncryptionKeyRefresherMaxState> iStates;
hgs
parents:
diff changeset
    94
	};
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
//--------------------------------------------------
hgs
parents:
diff changeset
    99
// STATES, base 
hgs
parents:
diff changeset
   100
//--------------------------------------------------
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
NONSHARABLE_CLASS(TEncryptionKeyRefresherState)
hgs
parents:
diff changeset
   103
	{
hgs
parents:
diff changeset
   104
public:
hgs
parents:
diff changeset
   105
	TEncryptionKeyRefresherState(CEncryptionKeyRefresherStateFactory& aFactory);
hgs
parents:
diff changeset
   106
	
hgs
parents:
diff changeset
   107
	virtual void Enter(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   108
	virtual void Exit(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
	virtual void Start(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   111
	virtual void EventReceived(CEncryptionKeyRefresher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   112
	virtual void Error(CEncryptionKeyRefresher& aContext, TInt aErr) const;
hgs
parents:
diff changeset
   113
	virtual void TimerExpired(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   114
	virtual void EncryptionKeyRefreshComplete(CEncryptionKeyRefresher& aContext, TInt aError) const;
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
protected:
hgs
parents:
diff changeset
   117
	// Exits old state, sets the new state, and enters it.
hgs
parents:
diff changeset
   118
	void ChangeState(CEncryptionKeyRefresher& aContext, CEncryptionKeyRefresherStateFactory::TEncryptionKeyRefresherStates aState) const;
hgs
parents:
diff changeset
   119
	void PanicInState(TLinkPanic aPanic) const;
hgs
parents:
diff changeset
   120
	
hgs
parents:
diff changeset
   121
protected:
hgs
parents:
diff changeset
   122
	CEncryptionKeyRefresherStateFactory& iFactory;
hgs
parents:
diff changeset
   123
#ifdef __FLOG_ACTIVE
hgs
parents:
diff changeset
   124
	TBuf<48> iName;
hgs
parents:
diff changeset
   125
#endif
hgs
parents:
diff changeset
   126
	};
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
//--------------------------------------------------
hgs
parents:
diff changeset
   130
// STATES 
hgs
parents:
diff changeset
   131
//--------------------------------------------------
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
NONSHARABLE_CLASS(TEkrStateIdle) : public TEncryptionKeyRefresherState
hgs
parents:
diff changeset
   134
	{
hgs
parents:
diff changeset
   135
public:
hgs
parents:
diff changeset
   136
	TEkrStateIdle(CEncryptionKeyRefresherStateFactory& aFactory);
hgs
parents:
diff changeset
   137
hgs
parents:
diff changeset
   138
	virtual void Enter(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   139
	virtual void Start(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   140
	};
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
hgs
parents:
diff changeset
   143
NONSHARABLE_CLASS(TEkrStateDisablingLPM) : public TEncryptionKeyRefresherState
hgs
parents:
diff changeset
   144
	{
hgs
parents:
diff changeset
   145
public:
hgs
parents:
diff changeset
   146
	TEkrStateDisablingLPM(CEncryptionKeyRefresherStateFactory& aFactory);
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
	virtual void Enter(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   149
	virtual void EventReceived(CEncryptionKeyRefresher& aContext, TBTBasebandEventNotification& aEvent) const;
hgs
parents:
diff changeset
   150
	};
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
NONSHARABLE_CLASS(TEkrStateRefreshingKey) : public TEncryptionKeyRefresherState
hgs
parents:
diff changeset
   153
	{
hgs
parents:
diff changeset
   154
public:
hgs
parents:
diff changeset
   155
	TEkrStateRefreshingKey(CEncryptionKeyRefresherStateFactory& aFactory);
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
	virtual void Enter(CEncryptionKeyRefresher& aContext) const;
hgs
parents:
diff changeset
   158
	virtual void EncryptionKeyRefreshComplete(CEncryptionKeyRefresher& aContext, TInt aError) const;
hgs
parents:
diff changeset
   159
	};
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
hgs
parents:
diff changeset
   162
#ifdef __FLOG_ACTIVE
hgs
parents:
diff changeset
   163
#define STATENAME(x)  iName=_L(x)
hgs
parents:
diff changeset
   164
#else
hgs
parents:
diff changeset
   165
#define STATENAME(x)
hgs
parents:
diff changeset
   166
#endif
hgs
parents:
diff changeset
   167
hgs
parents:
diff changeset
   168
hgs
parents:
diff changeset
   169
#endif /* ENCRYPTIONKEYREFRESHHELPER_H */