File Information
Library: RemotingNG
Package: Transport
Header: Poco/RemotingNG/Authenticator.h
Description
The result of an (intermediate) authenticate request.
Member Summary
Member Functions: cont, conversationID, credentials, done, failed, operator =, state
Enumerations
State
AUTH_DONE = 0x01
Authentication completed successfully.
AUTH_CONTINUE = 0x02
Authentication step successful, continue with next step.
AUTH_FAILED = 0x80
Authentication failed.
Constructors
AuthenticateResult
Creates an empty AuthenticateResult with state AUTH_FAILED and conversation ID 0.
AuthenticateResult
explicit AuthenticateResult(
State state
);
Creates an empty AuthenticateResult with the given state and conversation ID 0.
AuthenticateResult
AuthenticateResult(
const AuthenticateResult & other
);
Creates an AuthenticateResult by copying another one.
AuthenticateResult
AuthenticateResult(
State state,
const Credentials & credentials,
Poco::UInt32 conversationID = 0
);
Creates an AuthenticateResult using the given state, credentials and conversationID.
Destructor
~AuthenticateResult
Destroys the AuthenticateResult.
Member Functions
cont
bool cont() const;
Returns true if the authentication step was successful and the next step must be performed to eventually complete authentication.
conversationID
Poco::UInt32 conversationID() const;
Returns the conversation ID.
credentials
const Credentials & credentials() const;
Returns the credentials.
done
bool done() const;
Returns true if authentication has completed successfully.
failed
bool failed() const;
Returns true if authentication has failed.
operator =
AuthenticateResult & operator = (
const AuthenticateResult & other
);
Assignment operator.
state
State state() const;
Returns the status.