astxx::manager::action::login Class Reference

#include <astxx/manager/action/login.h>

Inheritance diagram for astxx::manager::action::login:

[legend]

Collaboration diagram for astxx::manager::action::login:

[legend]

List of all members.

---

Detailed Description

Login to the manager.

Exceptions:

login::error

if there is an error logging in

Definition at line 40 of file login.h.

Public Member Functions
message::action	action () const
	Format this action as a message::action.
virtual void	action_id (const std::string &id)
	Set the ActionID for this action.
virtual std::string	action_id () const
	Get the ActionID for this action.
message::response	handle_response (message::response response)
	Handle the response to the login command.
	login (const std::string &username, const std::string &secret)
	Construct a login action.
message::response	operator() (connection &c)
	Send this action over this connection and handle the response.
Classes
class	error
	An authentication error. More...

---

Constructor & Destructor Documentation

astxx::manager::action::login::login	(	const std::string &	username,
		const std::string &	secret
	)			[inline]

Construct a login action.

Parameters:

	username	the username to use
	the	secret to use

Definition at line 53 of file login.h.

---

Member Function Documentation

message::action astxx::manager::action::login::action

(

)

const [inline, virtual]

Format this action as a message::action.

Returns:

this message as a message::action

Implements astxx::manager::basic_action.

Definition at line 59 of file login.h.

virtual std::string astxx::manager::basic_action::action_id

(

)

const [inline, virtual, inherited]

Get the ActionID for this action.

Returns:

the ActionID for this action.

Definition at line 62 of file basic_action.h.

Referenced by astxx::manager::action::status::action(), and astxx::manager::connection::send_action_async().

message::response astxx::manager::action::login::handle_response

(

message::response

response

)

[inline, virtual]

Handle the response to the login command.

Parameters:

response

the response from Asterisk

Exceptions:

login::error

if the login failed

Reimplemented from astxx::manager::basic_action.

Definition at line 70 of file login.h.

References astxx::manager::basic_action::handle_response().

message::response astxx::manager::basic_action::operator()

(

connection &

c

)

[inherited]

Send this action over this connection and handle the response.

Parameters:

c

the connection to use

This function sends this action over the give connection to Asterisk and then passes the response through basic_action::handle_response() before returning it. basic_action::handle_response() will throw exceptions for most common errors.

Returns:

the response from Asterisk

Definition at line 103 of file basic_action.cc.

References astxx::manager::basic_action::handle_response().

---

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

• include/astxx/manager/action/login.h