control_cmd_args_t Struct Reference

#include <control_cmd_args_st.h>

Data Fields
const char *	command
struct smartlist_t *	args
struct config_line_t *	kwargs
size_t	cmddata_len
char *	cmddata
const char *	raw_body

Detailed Description

Parsed arguments for a control command.

WORK IN PROGRESS: This structure is going to get more complex as this branch goes on.

Definition at line 24 of file control_cmd_args_st.h.

Field Documentation

args

struct smartlist_t* args

Positional arguments to the command.

Definition at line 33 of file control_cmd_args_st.h.

Referenced by control_cmd_args_free_(), control_cmd_args_wipe(), control_cmd_parse_args(), handle_control_add_onion(), handle_control_attachstream(), handle_control_authchallenge(), handle_control_closecircuit(), handle_control_closestream(), handle_control_del_onion(), handle_control_extendcircuit(), handle_control_getconf(), handle_control_getinfo(), handle_control_hsfetch(), handle_control_onion_client_auth_add(), handle_control_onion_client_auth_remove(), handle_control_onion_client_auth_view(), handle_control_protocolinfo(), handle_control_redirectstream(), handle_control_setcircuitpurpose(), handle_control_setevents(), handle_control_signal(), and handle_control_usefeature().

cmddata

char* cmddata

A multiline object passed with this command.

Definition at line 45 of file control_cmd_args_st.h.

Referenced by control_cmd_args_free_(), control_cmd_args_wipe(), control_cmd_parse_args(), handle_control_hspost(), handle_control_loadconf(), and handle_control_postdescriptor().

cmddata_len

size_t cmddata_len

Number of bytes in cmddata; 0 if cmddata is not set.

Definition at line 41 of file control_cmd_args_st.h.

Referenced by control_cmd_args_wipe(), and control_cmd_parse_args().

command

const char* command

The command itself, as provided by the controller. Not owned by this structure.

Definition at line 29 of file control_cmd_args_st.h.

Referenced by control_cmd_parse_args().

kwargs

struct config_line_t* kwargs

Keyword arguments to the command.

Definition at line 37 of file control_cmd_args_st.h.

Referenced by control_cmd_args_free_(), control_cmd_args_wipe(), control_cmd_parse_args(), control_setconf_helper(), handle_control_add_onion(), handle_control_attachstream(), handle_control_authchallenge(), handle_control_authenticate(), handle_control_closecircuit(), handle_control_extendcircuit(), handle_control_hsfetch(), handle_control_hspost(), handle_control_mapaddress(), handle_control_onion_client_auth_add(), handle_control_postdescriptor(), handle_control_resolve(), handle_control_saveconf(), handle_control_setcircuitpurpose(), and kvline_check_keyword_args().

raw_body

const char* raw_body

If set, a nul-terminated string containing the raw unparsed arguments.

Definition at line 49 of file control_cmd_args_st.h.

Referenced by control_cmd_parse_args(), handle_control_authchallenge(), and handle_control_authenticate().

---

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

• feature/control/control_cmd_args_st.h