AMPS C/C++ Client Class Reference
AMPS C/C++ Client Version 5.3.3.1
AMPS::DefaultAuthenticator Class Reference

A default implementation of Authenticator that only uses an unchanged password and does not implement retry. More...

#include <ampsplusplus.hpp>

+ Inheritance diagram for AMPS::DefaultAuthenticator:

Public Member Functions

std::string authenticate (const std::string &, const std::string &password_)
 A simple implementation that returns an unmodified password.
 
std::string retry (const std::string &, const std::string &)
 Throws an AuthenticationException because retry is not implemented.
 
void completed (const std::string &, const std::string &, const std::string &)
 Called by Client once a logon completes successfully. More...
 

Static Public Member Functions

static Authenticatorinstance ()
 Static function to return a static instance used when no Authenticator is supplied to a Client. More...
 

Detailed Description

A default implementation of Authenticator that only uses an unchanged password and does not implement retry.

Member Function Documentation

void AMPS::DefaultAuthenticator::completed ( const std::string &  userName_,
const std::string &  password_,
const std::string &  reason_ 
)
inlinevirtual

Called by Client once a logon completes successfully.

Parameters
userName_The user name that successfully logged on to the server.
password_The password that successfully logged on to the server.
reason_The reason for successful completion, taken from the message returned by the server.

Implements AMPS::Authenticator.

static Authenticator& AMPS::DefaultAuthenticator::instance ( )
inlinestatic

Static function to return a static instance used when no Authenticator is supplied to a Client.


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