Public Types
Public Methods
-  RouterCLI (XorpShellBase& xorpsh, CliNode& cli_node,
	      XorpFd cli_client_input_fd, XorpFd cli_client_output_fd,
	      bool verbose) 
 
-  ~RouterCLI () 
 
- bool  done ()  const
 
- bool  is_config_mode ()  const
 
- void  clear_command_set () 
 
- int  configure_func (const string& ,
		       const string& ,
		       uint32_t ,
		       const vector<string>& command_global_name,
		       const vector<string>& argv) 
 
- void  enter_config_done (const XrlError& e) 
 
- void  got_config_users (const XrlError& e, const XrlAtomList* users) 
 
- void  new_config_user (uid_t user_id) 
 
- void  leave_config_done (const XrlError& e) 
 
- void  notify_user (const string& alert, bool urgent) 
 
- void  config_changed_by_other_user () 
 
- int  op_help_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv) 
 
- int  conf_help_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv) 
 
- int  logout_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv) 
 
- int  exit_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv) 
 
- int  edit_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv) 
 
- int  extract_leaf_node_operator_and_value (const TemplateTreeNode& ttn,
					     const vector<string>& argv,
					     ConfigOperator& node_operator,
					     string& value,
					     string& error_msg) 
 
- map<string, CliCommandMatch>  text_entry_children_func (
	const vector<string>& vector_path)  const
 
- int  text_entry_func (const string& ,
			const string& ,
			uint32_t ,
			const vector<string>& command_global_name,
			const vector<string>& argv) 
 
- int  delete_func (const string& ,
		    const string& ,
		    uint32_t ,
		    const vector<string>& command_global_name,
		    const vector<string>& argv) 
 
- int  commit_func (const string& ,
		    const string& ,
		    uint32_t ,
		    const vector<string>& command_global_name,
		    const vector<string>& argv) 
 
- void  commit_done (bool success, string error_msg) 
 
- int  show_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv) 
 
- int  op_mode_func (const string& ,
		     const string& ,
		     uint32_t ,
		     const vector<string>& command_global_name,
		     const vector<string>& argv) 
 
- int  save_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv) 
 
- void  save_communicated (const XrlError& e) 
 
- void  save_done (bool success, string error_msg) 
 
- int  load_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv) 
 
- void  load_communicated (const XrlError& e) 
 
- void  load_done (bool success, string error_msg) 
 
- map<string, CliCommandMatch>  op_mode_help (const vector<string>& command_global_name)  const
 
- map<string, CliCommandMatch>  configure_mode_help (const vector<string>& command_global_name)  const
 
- void  op_mode_cmd_print (const string& result) 
 
- void  op_mode_cmd_done (bool success, const string& error_msg) 
 
- void  op_mode_cmd_interrupt (const string& server_name,
			       const string& cli_term_name,
			       uint32_t cli_session_id,
			       const vector<string>& command_global_name,
			       const vector<string>& command_args) 
 
- void  op_mode_cmd_tidy () 
 
 [const]
bool  is_config_mode ()
  | is_config_mode | 
 [const]
void  clear_command_set ()
  | clear_command_set | 
int  configure_func (const string& ,
		       const string& ,
		       uint32_t ,
		       const vector<string>& command_global_name,
		       const vector<string>& argv)
  | configure_func | 
void  enter_config_done (const XrlError& e)
  | enter_config_done | 
void  new_config_user (uid_t user_id)
  | new_config_user | 
void  leave_config_done (const XrlError& e)
  | leave_config_done | 
void  notify_user (const string& alert, bool urgent)
  | notify_user | 
void  config_changed_by_other_user ()
  | config_changed_by_other_user | 
int  op_help_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv)
  | op_help_func | 
int  conf_help_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv)
  | conf_help_func | 
int  logout_func (const string& ,
		   const string& ,
		   uint32_t ,
		   const vector<string>& command_global_name,
		   const vector<string>& argv)
  | logout_func | 
int  exit_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv)
  | exit_func | 
int  edit_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv)
  | edit_func | 
int  extract_leaf_node_operator_and_value (const TemplateTreeNode& ttn,
					     const vector<string>& argv,
					     ConfigOperator& node_operator,
					     string& value,
					     string& error_msg)
  | extract_leaf_node_operator_and_value | 
map<string, CliCommandMatch>  text_entry_children_func (
	const vector<string>& vector_path)
  | text_entry_children_func | 
 [const]
int  text_entry_func (const string& ,
			const string& ,
			uint32_t ,
			const vector<string>& command_global_name,
			const vector<string>& argv)
  | text_entry_func | 
int  delete_func (const string& ,
		    const string& ,
		    uint32_t ,
		    const vector<string>& command_global_name,
		    const vector<string>& argv)
  | delete_func | 
int  commit_func (const string& ,
		    const string& ,
		    uint32_t ,
		    const vector<string>& command_global_name,
		    const vector<string>& argv)
  | commit_func | 
void  commit_done (bool success, string error_msg)
  | commit_done | 
int  show_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv)
  | show_func | 
int  op_mode_func (const string& ,
		     const string& ,
		     uint32_t ,
		     const vector<string>& command_global_name,
		     const vector<string>& argv)
  | op_mode_func | 
int  save_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv)
  | save_func | 
void  save_communicated (const XrlError& e)
  | save_communicated | 
void  save_done (bool success, string error_msg)
  | save_done | 
int  load_func (const string& ,
		  const string& ,
		  uint32_t ,
		  const vector<string>& command_global_name,
		  const vector<string>& argv)
  | load_func | 
void  load_communicated (const XrlError& e)
  | load_communicated | 
void  load_done (bool success, string error_msg)
  | load_done | 
map<string, CliCommandMatch>  op_mode_help (const vector<string>& command_global_name)
  | op_mode_help | 
 [const]
map<string, CliCommandMatch>  configure_mode_help (const vector<string>& command_global_name)
  | configure_mode_help | 
 [const]
| typedef XorpCallback1<void, const string&>::RefPtr  OpModePrintCallback | OpModePrintCallback | 
| typedef XorpCallback2<void, bool,const string&>::RefPtr  OpModeDoneCallback | OpModeDoneCallback | 
void  op_mode_cmd_print (const string& result)
  | op_mode_cmd_print | 
 Callback: partial output generated by the operational command
Parameters:
void  op_mode_cmd_done (bool success, const string& error_msg)
  | op_mode_cmd_done | 
 Callback: called when the operational command completes
Parameters:
| success | true if the command suceeded
 | 
| error_msg | if the command failed the error message
      | 
void  op_mode_cmd_interrupt (const string& server_name,
			       const string& cli_term_name,
			       uint32_t cli_session_id,
			       const vector<string>& command_global_name,
			       const vector<string>& command_args)
  | op_mode_cmd_interrupt | 
 Callback: called when a user send an interrupt terminate the
 operational mode command if there is one running.
Parameters:
| server_name | the name of the server that returned the result.
 | 
| cli_term_name | the name of the terminal that originated
 the command.
 | 
| cli_session_id | the session ID of the terminal that originated
 the command.
 | 
| command_global_name | the name of the command that is interrupted.
 | 
| command_args | the arguments to the command that is interrupted.
      | 
void  op_mode_cmd_tidy ()
  | op_mode_cmd_tidy | 
 Tidy up operational mode command.
 Can safely be called multiple times.
     
	
Generated by: pavlin on possum.icir.org on Wed Mar 21 11:24:12 2007, using kdoc $.