mongo::SaslPLAINClientConversation Class Reference

Client side authentication session for SASL PLAIN. More...

#include <sasl_plain_client_conversation.h>

Inheritance diagram for mongo::SaslPLAINClientConversation:

Public Member Functions
	SaslPLAINClientConversation (SaslClientSession *saslClientSession)
	Implements the client side of a SASL PLAIN mechanism session.
virtual StatusWith< bool >	step (const StringData &inputData, std::string *outputData)
	Performs one step of the client side of the authentication session, consuming "inputData" and producing "*outputData". More...
Public Member Functions inherited from mongo::SaslClientConversation
	SaslClientConversation (SaslClientSession *saslClientSession)
	Implements the client side of a SASL authentication mechanism. More...

Detailed Description

Client side authentication session for SASL PLAIN.

Member Function Documentation

virtual StatusWith<bool> mongo::SaslPLAINClientConversation::step ( const StringData &  inputData, std::string *  outputData  )

virtual

Performs one step of the client side of the authentication session, consuming "inputData" and producing "*outputData".

A return of Status::OK() indicates successful progress towards authentication. A return of !Status::OK() indicates failed authentication

A return of true means that the authentication process has finished. A return of false means that the authentication process has more steps.

Implements mongo::SaslClientConversation.

---

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

• src/mongo/client/sasl_plain_client_conversation.h