PSASLClient Class Reference

#include <psasl.h>

Inheritance diagram for PSASLClient:

Collaboration diagram for PSASLClient:

Public Types
enum	PSASLResult { Continue = 1, OK = 0, Fail = -1 }
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the Compare() function. More...

Public Member Functions
	PSASLClient (const PString &service, const PString &uid, const PString &auth, const PString &pwd)
	~PSASLClient ()
const PString &	GetService () const
const PString &	GetUserID () const
const PString &	GetAuthID () const
const PString &	GetPassword () const
PBoolean	Init (const PString &fqdn, PStringSet &supportedMechanisms)
PBoolean	Start (const PString &mechanism, PString &output)
PSASLResult	Negotiate (const PString &input, PString &output)
PBoolean	End ()
Public Member Functions inherited from PObject
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
void	SetTraceContextIdentifier (unsigned id)
void	GetTraceContextIdentifier (PObject &obj)
void	GetTraceContextIdentifier (PObject *obj)
void	SetTraceContextIdentifier (const PObject &obj)
void	SetTraceContextIdentifier (const PObject *obj)
virtual	~PObject ()
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...
virtual PINDEX	HashFunction () const
	This function yields a hash value required by the PDictionary class. More...
virtual const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...
__inline const PObject *	PTraceObjectInstance () const
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...
bool	operator== (const PObject &obj) const
	Compare the two objects. More...
bool	operator!= (const PObject &obj) const
	Compare the two objects. More...
bool	operator< (const PObject &obj) const
	Compare the two objects. More...
bool	operator> (const PObject &obj) const
	Compare the two objects. More...
bool	operator<= (const PObject &obj) const
	Compare the two objects. More...
bool	operator>= (const PObject &obj) const
	Compare the two objects. More...
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Static Public Member Functions
static void	SetRealm (const PString &realm)
static void	SetPath (const PString &path)
static const PString &	GetRealm ()
static const PString &	GetPath ()
Static Public Member Functions inherited from PObject
static const char *	Class ()
	Get the name of the class as a C string. More...
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Member Functions
PBoolean	Start (const PString &mechanism, const char **output, unsigned &len)
PSASLResult	Negotiate (const char *input, const char **output)
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
struct sasl_callback *	m_CallBacks
struct sasl_conn *	m_ConnState
const PString	m_Service
const PString	m_UserID
const PString	m_AuthID
const PString	m_Password
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Static Protected Attributes
static PString	s_Realm
static PString	s_Path

Member Enumeration Documentation

enum PSASLClient::PSASLResult

Enumerator
Continue
OK
Fail

Constructor & Destructor Documentation

PSASLClient::PSASLClient	(	const PString &	service,
		const PString &	uid,
		const PString &	auth,
		const PString &	pwd
	)

PSASLClient::~PSASLClient

(

)

Member Function Documentation

PBoolean PSASLClient::End

(

)

const PString& PSASLClient::GetAuthID ( ) const

inline

References m_AuthID.

const PString& PSASLClient::GetPassword ( ) const

inline

References m_Password.

static const PString& PSASLClient::GetPath ( )

inlinestatic

References s_Path.

static const PString& PSASLClient::GetRealm ( )

inlinestatic

References s_Realm.

const PString& PSASLClient::GetService ( ) const

inline

References m_Service.

const PString& PSASLClient::GetUserID ( ) const

inline

References m_UserID.

PBoolean PSASLClient::Init	(	const PString &	fqdn,
		PStringSet &	supportedMechanisms
	)

PSASLResult PSASLClient::Negotiate ( const char *  input, const char **  output  )

protected

PSASLResult PSASLClient::Negotiate	(	const PString &	input,
		PString &	output
	)

static void PSASLClient::SetPath ( const PString &  path )

inlinestatic

References s_Path.

static void PSASLClient::SetRealm ( const PString &  realm )

inlinestatic

References s_Realm.

PBoolean PSASLClient::Start ( const PString &  mechanism, const char **  output, unsigned &  len  )

protected

PBoolean PSASLClient::Start	(	const PString &	mechanism,
		PString &	output
	)

Member Data Documentation

const PString PSASLClient::m_AuthID

protected

Referenced by GetAuthID().

struct sasl_callback* PSASLClient::m_CallBacks

protected

struct sasl_conn* PSASLClient::m_ConnState

protected

const PString PSASLClient::m_Password

protected

Referenced by GetPassword().

const PString PSASLClient::m_Service

protected

Referenced by GetService().

const PString PSASLClient::m_UserID

protected

Referenced by GetUserID().

PString PSASLClient::s_Path

staticprotected

Referenced by GetPath(), and SetPath().

PString PSASLClient::s_Realm

staticprotected

Referenced by GetRealm(), and SetRealm().

---

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

• psasl.h