cryptonote::rpc_args Struct Reference

Processes command line arguments related to server-side RPC. More...

#include <rpc_args.h>

Collaboration diagram for cryptonote::rpc_args:

Classes
struct	descriptors

Static Public Member Functions
static const char *	tr (const char *str)
static void	init_options (boost::program_options::options_description &desc, const bool any_cert_option=false)
static boost::optional< rpc_args >	process (const boost::program_options::variables_map &vm, const bool any_cert_option=false)
static boost::optional< epee::net_utils::ssl_options_t >	process_ssl (const boost::program_options::variables_map &vm, const bool any_cert_option=false)

Public Attributes
std::string	bind_ip
std::string	bind_ipv6_address
std::string	restricted_bind_ip
std::string	restricted_bind_ipv6_address
bool	use_ipv6
bool	require_ipv4
std::vector< std::string >	access_control_origins
boost::optional< tools::login >	login
epee::net_utils::ssl_options_t	ssl_options = epee::net_utils::ssl_support_t::e_ssl_support_enabled
bool	disable_rpc_ban = false

Detailed Description

Processes command line arguments related to server-side RPC.

Member Function Documentation

init_options()

void cryptonote::rpc_args::init_options ( boost::program_options::options_description & desc, const bool any_cert_option = false )

static

process()

boost::optional< rpc_args > cryptonote::rpc_args::process ( const boost::program_options::variables_map & vm, const bool any_cert_option = false )

static

Returns

Arguments specified by user, or boost::none if error

process_ssl()

boost::optional< epee::net_utils::ssl_options_t > cryptonote::rpc_args::process_ssl ( const boost::program_options::variables_map & vm, const bool any_cert_option = false )

static

Returns

SSL arguments specified by user, or boost::none if error

tr()

const char * cryptonote::rpc_args::tr ( const char * str )

static

Member Data Documentation

access_control_origins

std::vector<std::string> cryptonote::rpc_args::access_control_origins

bind_ip

std::string cryptonote::rpc_args::bind_ip

bind_ipv6_address

std::string cryptonote::rpc_args::bind_ipv6_address

disable_rpc_ban

bool cryptonote::rpc_args::disable_rpc_ban = false

login

boost::optional<tools::login> cryptonote::rpc_args::login

require_ipv4

bool cryptonote::rpc_args::require_ipv4

restricted_bind_ip

std::string cryptonote::rpc_args::restricted_bind_ip

restricted_bind_ipv6_address

std::string cryptonote::rpc_args::restricted_bind_ipv6_address

ssl_options

epee::net_utils::ssl_options_t cryptonote::rpc_args::ssl_options = epee::net_utils::ssl_support_t::e_ssl_support_enabled

use_ipv6

bool cryptonote::rpc_args::use_ipv6

---

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

• src/rpc/rpc_args.h
• src/rpc/rpc_args.cpp