sbuild::AuthMessage Class Reference

Authentication messages. More...

#include <sbuild-auth-message.h>

List of all members.

Public Types

enum  MessageType { MESSAGE_PROMPT_NOECHO = PAM_PROMPT_ECHO_OFF, MESSAGE_PROMPT_ECHO = PAM_PROMPT_ECHO_ON, MESSAGE_ERROR = PAM_ERROR_MSG, MESSAGE_INFO = PAM_TEXT_INFO }
 Message type. More...

Public Member Functions

 AuthMessage (MessageType type, std::string const &message)
 The constructor.
virtual ~AuthMessage ()
 The destructor.

Public Attributes

MessageType type
 The type of message.
std::string message
 The message to display.
std::string response
 The user's response (if any).


Detailed Description

Authentication messages.

When Auth needs to interact with the user, it does this by sending a list of AuthMessage objects to an AuthConv conversation object. These messages tell the conversation object how to display the message to the user, and if necessary, whether or not to ask the user for some input. They also store the user's input, if required.


Member Enumeration Documentation

enum sbuild::AuthMessage::MessageType
 

Message type.

Enumerator:
MESSAGE_PROMPT_NOECHO  Display a prompt, with no echoing of user input.
MESSAGE_PROMPT_ECHO  Display a prompt, echoing user input.
MESSAGE_ERROR  Display an error message.
MESSAGE_INFO  Display an informational message.


Constructor & Destructor Documentation

AuthMessage::AuthMessage MessageType  type,
std::string const &  message
 

The constructor.

Parameters:
type the type of message.
message the message to display.

AuthMessage::~AuthMessage  )  [virtual]
 

The destructor.


Member Data Documentation

std::string sbuild::AuthMessage::message
 

The message to display.

std::string sbuild::AuthMessage::response
 

The user's response (if any).

MessageType sbuild::AuthMessage::type
 

The type of message.


The documentation for this class was generated from the following files:
Generated on Mon Jan 30 13:23:55 2006 for schroot by  doxygen 1.4.6