EapAuthSwitchStateMachine Class Reference

#include <eap_authfsm.hxx>

Inheritance diagram for EapAuthSwitchStateMachine:

List of all members.

Public Types
enum	EapAuthDecision { DecisionSuccess, DecisionFailure, DecisionContinue, DecisionPassthrough }
enum	EapAuthMethodState { PROPOSED = 0, CONT, END }
enum	event {   EvRxMsg = -1, EvSgPortEnabled = -2, EvSgValidResp = -3, EvSgInvalidResp = -4,   EvSgEndMethod = -5, EvSgRestart = -6, EvSgAaaContinue = -7, EvSgAaaSuccess = -8,   EvSgAaaFailure = -9 }
	External events passed from applications and methods.
Public Member Functions
void	Receive (AAAMessageBlock *)
virtual void	Success (AAAMessageBlock *b)=0
virtual void	Success ()=0
virtual void	Failure (AAAMessageBlock *b)=0
virtual void	Failure ()=0
ACE_UINT16 &	MaxRetransmissionCount ()
ACE_UINT16 &	RetransmissionInterval ()
virtual bool	IsEapBackend (void)
	Call this function to set the isEapBackend variable.
bool	RetransmissionEnabled ()
	Call this function to check whether retransmission is enabled.
void	NeedInitialRequestToSend (bool b)
bool	NeedInitialRequestToSend ()
std::string &	NotificationString ()
	Call this function to get the reference to the notificationString.
ACE_UINT16 &	RetransmissionCount ()
	Call this function to get the reference to the retransmissionCount.
virtual EapAuthDecision	Decision ()
	Call this function to obtain the authenticator decision.
EapAuthMethodState &	MethodState ()
Protected Member Functions
	EapAuthSwitchStateMachine (ACE_Reactor &r, EapJobHandle &h)
Protected Attributes
ACE_UINT16	discardCount
	This variable is incremented when a received message is discarded.
ACE_UINT16	retransmissionCount
ACE_UINT16	maxRetransmissionCount
ACE_UINT16	retransmissionInterval
std::string	notificationString
bool	needInitialRequestToSend
EapAuthMethodState	methodState
	This variable stores method state.
Static Protected Attributes
const ACE_UINT16	defaultMaxRetransmissionCount
const ACE_UINT16	defaultRetransmissionInterval

---

Detailed Description

A class for authetnicator state machine. Class creation can be made only by EapSession.

---

Member Enumeration Documentation

enum EapAuthSwitchStateMachine::EapAuthMethodState

External method state visibile to authenticator switch state machine. The state is updated by the authenticator state machine.

---

Member Function Documentation

virtual void EapAuthSwitchStateMachine::Failure (   )  [pure virtual]

This Success callback is called when EAP authentication fails without generating an EAP-Failure message.

virtual void EapAuthSwitchStateMachine::Failure (  AAAMessageBlock *  b  )  [pure virtual]

A callback function called when the EAP session completes with failure. Failure message is contained in the argument of Failure(). It is up to the implementation of the derived class whether Failure message is actually sent or not. If further processing for the message is performed in other threads, the application must make a duplication of the message via AAAMessageBlock::Acquire(AAAMessageBlock*) so that the API will not release the message allocation until reference count becomes 0.

ACE_UINT16& EapAuthSwitchStateMachine::MaxRetransmissionCount (   )  [inline]

Call this function to get the reference to the maximum retransmission count.

bool EapAuthSwitchStateMachine::NeedInitialRequestToSend (   )  [inline]

Call this function to check whether the backend authenticator sends the initial Request.

void EapAuthSwitchStateMachine::NeedInitialRequestToSend (  bool  b  )  [inline]

Call this function to set whether the backend authenticator sends the initial Request.

void EapAuthSwitchStateMachine::Receive (  AAAMessageBlock *   )  [virtual]

This function is called when an application receives an EAP message that needs to be processed by the state machine. Implements EapSwitchStateMachine.

ACE_UINT16& EapAuthSwitchStateMachine::RetransmissionInterval (   )  [inline]

Call this function to get the reference to the retransmission interval value.

virtual void EapAuthSwitchStateMachine::Success (   )  [pure virtual]

This Success callback is called when EAP authentication succeeds without generating an EAP-Success message.

virtual void EapAuthSwitchStateMachine::Success (  AAAMessageBlock *  b  )  [pure virtual]

A callback function called when the EAP session completes with success. Success message is contained in the argument of Success(). It is up to the implementation of the derived class whether Success message is actually sent or not. If further processing for the message is performed in other threads, the application must make a duplication of the message via AAAMessageBlock::Acquire(AAAMessageBlock*) so that the API will not release the message allocation until reference count becomes 0.

---

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

• eap_authfsm.hxx

---