sbuild::auth_message Class Reference

Authentication messages. More...

#include <sbuild-auth-message.h>

Collaboration diagram for sbuild::auth_message:

Collaboration graph
[legend]
List of all members.

Public Types

enum  message_type { 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

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

Public Attributes

message_type 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 auth_message 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.

Definition at line 40 of file sbuild-auth-message.h.


Member Enumeration Documentation

enum sbuild::auth_message::message_type

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.

Definition at line 44 of file sbuild-auth-message.h.


Constructor & Destructor Documentation

auth_message::auth_message ( message_type  type,
std::string const &  message 
)

The constructor.

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

Definition at line 26 of file sbuild-auth-message.cc.

auth_message::~auth_message (  )  [virtual]

The destructor.

Definition at line 34 of file sbuild-auth-message.cc.


Member Data Documentation

message_type sbuild::auth_message::type

The type of message.

Definition at line 69 of file sbuild-auth-message.h.

std::string sbuild::auth_message::message

The message to display.

Definition at line 71 of file sbuild-auth-message.h.

std::string sbuild::auth_message::response

The user's response (if any).

Definition at line 73 of file sbuild-auth-message.h.


The documentation for this class was generated from the following files:
Generated on Sat Jan 27 16:12:50 2007 for schroot by  doxygen 1.5.1