rnr::Session Class Reference

Session Class. More...

#include <Session.h>

Inheritance diagram for rnr::Session:

Public Member Functions
	Session (int nSessionId=0, const std::string &strSessionName="Session")
	Default initialization contructor. More...
	~Session ()
	Destructor.
StateMach &	sm ()
	Session's state machine. More...
int	getSessionId () const
	Get session id. More...
std::string	getSessionName () const
	Get session name. More...
void	setContext (void *pContext)
	Set state relevant context. More...
void *	getContext ()
	Get state relevant context. More...
void	setError (int ecode, const char *sFmt,...)
	Set session error. More...
void	setFatal (int ecode, const char *sFmt,...)
	Set session fatal error. More...
int	getErrorCode ()
	Get the last error code. More...
std::string	getErrorMsg ()
	Get the last error message. More...
bool	isFatal ()
	Test if session is in fatal condition. More...

Protected Attributes
int	m_nSessionId
	session id
std::string	m_strSessionName
	session name
StateMach	m_sm
	session state machine
void *	m_pContext
	state specific data
int	m_ecode
	last error code
char	m_bufErrorMsg [256]
	error message
bool	m_bHasFatal
	does [not] have fatal condition

Detailed Description

Session Class.

Session state data persist throughout the lifetime of an application or user session. Applications may support multiple sessions simultaneously.

Definition at line 84 of file Session.h.

Constructor & Destructor Documentation

rnr::Session::Session ( int  nSessionId = 0, const std::string &  strSessionName = "Session"  )

inline

Default initialization contructor.

Parameters

nSessionId	Session id.
strSessionName	Session name.

Definition at line 93 of file Session.h.

                                                                             :
        m_nSessionId(nSessionId), m_strSessionName(strSessionName),
        m_sm(nSessionId, strSessionName)
    {
    }

Member Function Documentation

void* rnr::Session::getContext ( )

inline

Get state relevant context.

Returns

State specific context data.

Definition at line 151 of file Session.h.

References m_pContext, setError(), and setFatal().

    {
      return m_pContext;
    }

int rnr::Session::getErrorCode ( )

inline

Get the last error code.

Returns

Application specific error code.

Definition at line 179 of file Session.h.

References m_ecode.

    {
      return m_ecode;
    }

std::string rnr::Session::getErrorMsg ( )

inline

Get the last error message.

Returns

Error message.

Definition at line 189 of file Session.h.

References m_bufErrorMsg.

    {
      return m_bufErrorMsg;
    }

int rnr::Session::getSessionId ( ) const

inline

Get session id.

Returns

Session id.

Definition at line 121 of file Session.h.

References m_nSessionId.

    {
      return m_nSessionId;
    }

std::string rnr::Session::getSessionName ( ) const

inline

Get session name.

Returns

String.

Definition at line 131 of file Session.h.

References m_strSessionName.

    {
      return m_strSessionName;
    }

bool rnr::Session::isFatal ( )

inline

Test if session is in fatal condition.

Returns

Returns true or false.

Definition at line 199 of file Session.h.

References m_bHasFatal.

    {
      return m_bHasFatal;
    }

void rnr::Session::setContext ( void *  pContext )

inline

Set state relevant context.

Parameters

pContext

State specific context data.

Definition at line 141 of file Session.h.

References m_pContext.

    {
      m_pContext = pContext;
    }

void Session::setError	(	int	ecode,
		const char *	sFmt,
			...
	)

Set session error.

Parameters

ecode	Application specific error code.
sFmt	Format string.
...	Formatted variable arguments.

Definition at line 72 of file Session.cxx.

Referenced by getContext().

{
  va_list         ap;

  m_ecode = ecode;

  // format error message
  va_start(ap, sFmt);
  vsnprintf(m_bufErrorMsg, sizeof(m_bufErrorMsg), sFmt, ap);
  m_bufErrorMsg[sizeof(m_bufErrorMsg)-1] = 0;
  va_end(ap);
}

void Session::setFatal	(	int	ecode,
		const char *	sFmt,
			...
	)

Set session fatal error.

Parameters

ecode	Application specific error code.
sFmt	Format string.
...	Formatted variable arguments.

Definition at line 85 of file Session.cxx.

Referenced by getContext().

{
  va_list         ap;

  m_ecode     = ecode;
  m_bHasFatal = true;

  // format error message
  va_start(ap, sFmt);
  vsnprintf(m_bufErrorMsg, sizeof(m_bufErrorMsg), sFmt, ap);
  m_bufErrorMsg[sizeof(m_bufErrorMsg)-1] = 0;
  va_end(ap);
}

StateMach& rnr::Session::sm ( )

inline

Session's state machine.

Returns

State machine reference.

Definition at line 111 of file Session.h.

References m_sm.

    {
      return m_sm;
    }

---

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

• include/rnr/appkit/Session.h
• sw/librnr_appkit/Session.cxx