EapMethodStateMachine Class Reference

The base class for method state machines. More...

#include <eap_fsm.hxx>

Inheritance diagram for EapMethodStateMachine:

List of all members.

Public Types
enum	event { EvSgIntegrityCheck = -1 }
	External event passed from switch.
Public Member Functions
virtual void	Start ()=0 throw (AAA_Error)
virtual void	Notify (AAA_Event)=0
bool	KeyAvailable ()
	Call this function to check the availability of the key.
std::string &	KeyData ()
	Call this function to retrieve the key.
AAA_JobData &	JobData ()
	Call this function to obtain the job data.
template<class T> T &	JobData (Type2Type< T >)
bool &	IsDone ()
	Call this function to check whether the method is done.
EapSwitchStateMachine &	SwitchStateMachine ()
	Call this function to get the pointer to method state machine.
virtual ACE_Byte	GetNextIdentifier (ACE_Byte id)
EapPeerSwitchStateMachine &	PeerSwitchStateMachine ()
EapAuthSwitchStateMachine &	AuthSwitchStateMachine ()
template<class T> T &	SwitchStateMachine (Type2Type< T >)
Protected Member Functions
	EapMethodStateMachine (EapSwitchStateMachine &s)
Protected Attributes
EapSwitchStateMachine &	switchStateMachine
	This contains the pointer to the switch state machine.
bool	isDone
std::string	keyData

---

Detailed Description

The base class for method state machines.

---

Member Function Documentation

EapAuthSwitchStateMachine& EapMethodStateMachine::AuthSwitchStateMachine (   )  [inline]

Call this function to get the reference to authenticator switch state machine.

virtual ACE_Byte EapMethodStateMachine::GetNextIdentifier (  ACE_Byte  id  )  [inline, virtual]

Override this function to implement differnet next identifier allocation policies.

virtual void EapMethodStateMachine::Notify (  AAA_Event   )  [pure virtual]

This pure virtual function is called when scheduling a method event. Implemented in EapPeerArchieStateMachine, EapAuthArchieStateMachine, EapAuthIdentityStateMachine, EapPeerMD5ChallengeStateMachine, EapAuthMD5ChallengeStateMachine, EapAuthNotificationStateMachine, EapPeerTlsStateMachine, and EapAuthTlsStateMachine.

EapPeerSwitchStateMachine& EapMethodStateMachine::PeerSwitchStateMachine (   )  [inline]

Call this function to get the reference to peer switch state machine.

virtual void EapMethodStateMachine::Start (   )  throw (AAA_Error) [pure virtual]

This pure virtual function is called when starting any method state machine. Implemented in EapPeerArchieStateMachine, EapAuthArchieStateMachine, EapAuthIdentityStateMachine, EapPeerMD5ChallengeStateMachine, EapAuthMD5ChallengeStateMachine, EapAuthNotificationStateMachine, EapPeerTlsStateMachine, and EapAuthTlsStateMachine.

---

Member Data Documentation

bool EapMethodStateMachine::isDone [protected]

This variable indicates whether the method is done. It is the responsibility of each EAP method implementation to set this variable to an appropriate value when the method is done.

std::string EapMethodStateMachine::keyData [protected]

This variable stores the key. It is the responsibility of each EAP method implementation to initialize and set this variable.

---

The documentation for this class was generated from the following file:

• eap_fsm.hxx

---