Commit f02efa83 authored by JINMEI Tatuya's avatar JINMEI Tatuya
Browse files

[2138] added suggested revised doc for AuthCommand::exec().

parent c286d6ae
...@@ -98,9 +98,16 @@ public: ...@@ -98,9 +98,16 @@ public:
/// \c AuthCommandError when it encounters an internal error, such as /// \c AuthCommandError when it encounters an internal error, such as
/// semantics error on the command arguments. /// semantics error on the command arguments.
/// ///
/// This method should return the execution result in the form of
/// \c ConstElementPtr. It will be transparently used as the return
/// value from the command handler called from the corresponding
/// \c CCSession object. For a successful completion of the command,
/// it should suffice to return the return value of
/// \c isc::config::createAnswer() with no argument.
///
/// \param server The \c AuthSrv object on which the command is executed. /// \param server The \c AuthSrv object on which the command is executed.
/// \param args Command specific argument. /// \param args Command specific argument.
/// \return command result using createAnswer(). /// \return Command execution result.
virtual ConstElementPtr exec(AuthSrv& server, virtual ConstElementPtr exec(AuthSrv& server,
isc::data::ConstElementPtr args) = 0; isc::data::ConstElementPtr args) = 0;
}; };
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment