RPCConsole Class Reference

Local Raven RPC console. More...

#include <rpcconsole.h>

Inheritance diagram for RPCConsole:

Collaboration diagram for RPCConsole:

Public Types
enum	MessageClass {   MC_ERROR, MC_DEBUG, CMD_REQUEST, CMD_REPLY,   CMD_ERROR }
enum	TabTypes {   TAB_INFO = 0, TAB_CONSOLE = 1, TAB_GRAPH = 2, TAB_PEERS = 3,   TAB_REPAIR = 4 }

Public Slots
void	clear (bool clearHistory=true)
void	fontBigger ()
void	fontSmaller ()
void	setFontSize (int newSize)
void	walletRescan ()
	Wallet repair options. More...
void	walletZaptxes1 ()
	Restart wallet with "-zapwallettxes=1". More...
void	walletReindex ()
	Restart wallet with "-reindex". More...
void	message (int category, const QString &message, bool html=false)
	Append the message to the message widget. More...
void	setNumConnections (int count)
	Set number of connections shown in the UI. More...
void	setNetworkActive (bool networkActive)
	Set network state shown in the UI. More...
void	setNumBlocks (int count, const QDateTime &blockDate, double nVerificationProgress, bool headers)
	Set number of blocks and last block date shown in the UI. More...
void	setMempoolSize (long numberOfTxs, size_t dynUsage)
	Set size (number of transactions and memory usage) of the mempool in the UI. More...
void	browseHistory (int offset)
	Go forward or back in history. More...
void	scrollToEnd ()
	Scroll console view to end. More...
void	peerSelected (const QItemSelection &selected, const QItemSelection &deselected)
	Handle selection of peer in peers list. More...
void	peerLayoutAboutToChange ()
	Handle selection caching before update. More...
void	peerLayoutChanged ()
	Handle updated peer information. More...
void	disconnectSelectedNode ()
	Disconnect a selected node on the Peers tab. More...
void	banSelectedNode (int bantime)
	Ban a selected node on the Peers tab. More...
void	unbanSelectedNode ()
	Unban a selected node on the Bans tab. More...
void	setTabFocus (enum TabTypes tabType)
	set which tab has the focus (is visible) More...

Signals
void	stopExecutor ()
void	cmdRequest (const QString &command)
void	handleRestart (QStringList args)
	Get restart command-line parameters and handle restart. More...

Public Member Functions
	RPCConsole (const PlatformStyle *platformStyle, QWidget *parent)
	~RPCConsole ()
void	setClientModel (ClientModel *model)

Static Public Member Functions
static bool	RPCParseCommandLine (std::string &strResult, const std::string &strCommand, bool fExecute, std::string *const pstrFilteredOut=nullptr)
	Split shell command line into a list of arguments and optionally execute the command(s). More...
static bool	RPCExecuteCommandLine (std::string &strResult, const std::string &strCommand, std::string *const pstrFilteredOut=nullptr)

Protected Member Functions
virtual bool	eventFilter (QObject *obj, QEvent *event)
void	keyPressEvent (QKeyEvent *)

Private Types
enum	ColumnWidths {   ADDRESS_COLUMN_WIDTH = 200, SUBVERSION_COLUMN_WIDTH = 150, PING_COLUMN_WIDTH = 80, BANSUBNET_COLUMN_WIDTH = 200,   BANTIME_COLUMN_WIDTH = 250 }

Private Slots
void	on_lineEdit_returnPressed ()
void	on_tabWidget_currentChanged (int index)
void	on_openDebugLogfileButton_clicked ()
	open the debug.log from the current datadir More...
void	on_sldGraphRange_valueChanged (int value)
	change the time range of the network traffic graph More...
void	updateTrafficStats (quint64 totalBytesIn, quint64 totalBytesOut)
	update traffic statistics More...
void	resizeEvent (QResizeEvent *event)
void	showEvent (QShowEvent *event)
void	hideEvent (QHideEvent *event)
void	showPeersTableContextMenu (const QPoint &point)
	Show custom context menu on Peers tab. More...
void	showBanTableContextMenu (const QPoint &point)
	Show custom context menu on Bans tab. More...
void	showOrHideBanTableIfRequired ()
	Hides ban table if no bans are present. More...
void	clearSelectedNode ()
	clear the selected node More...

Private Member Functions
void	startExecutor ()
void	setTrafficGraphRange (int mins)
void	buildParameterlist (QString arg)
	Build parameter list for restart. More...
void	updateNodeDetail (const CNodeCombinedStats *stats)
	show detailed information on ui about selected node More...
void	updateNetworkState ()
	Update UI with latest network info from model. More...

Private Attributes
Ui::RPCConsole *	ui
ClientModel *	clientModel
QStringList	history
int	historyPtr
QString	cmdBeforeBrowsing
QList< NodeId >	cachedNodeids
const PlatformStyle *	platformStyle
RPCTimerInterface *	rpcTimerInterface
QMenu *	peersTableContextMenu
QMenu *	banTableContextMenu
int	consoleFontSize
QCompleter *	autoCompleter
QThread	thread

Detailed Description

Local Raven RPC console.

Definition at line 32 of file rpcconsole.h.

Member Enumeration Documentation

ColumnWidths

enum RPCConsole::ColumnWidths

private

Enumerator
ADDRESS_COLUMN_WIDTH
SUBVERSION_COLUMN_WIDTH
PING_COLUMN_WIDTH
BANSUBNET_COLUMN_WIDTH
BANTIME_COLUMN_WIDTH

Definition at line 143 of file rpcconsole.h.

MessageClass

enum RPCConsole::MessageClass

Enumerator
MC_ERROR
MC_DEBUG
CMD_REQUEST
CMD_REPLY
CMD_ERROR

Definition at line 47 of file rpcconsole.h.

TabTypes

enum RPCConsole::TabTypes

Enumerator
TAB_INFO
TAB_CONSOLE
TAB_GRAPH
TAB_PEERS
TAB_REPAIR

Definition at line 55 of file rpcconsole.h.

Constructor & Destructor Documentation

RPCConsole()

RPCConsole::RPCConsole ( const PlatformStyle *  platformStyle, QWidget *  parent  )

explicit

Definition at line 429 of file rpcconsole.cpp.

Here is the call graph for this function:

~RPCConsole()

RPCConsole::~RPCConsole

(

)

Definition at line 494 of file rpcconsole.cpp.

Here is the call graph for this function:

Member Function Documentation

banSelectedNode

void RPCConsole::banSelectedNode ( int  bantime )

slot

Ban a selected node on the Peers tab.

Definition at line 1199 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

browseHistory

void RPCConsole::browseHistory ( int  offset )

slot

Go forward or back in history.

Definition at line 935 of file rpcconsole.cpp.

Here is the caller graph for this function:

buildParameterlist()

void RPCConsole::buildParameterlist ( QString  arg )

private

Build parameter list for restart.

Build command-line parameter list for restart.

Definition at line 757 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

clear

void RPCConsole::clear ( bool  clearHistory = true )

slot

Definition at line 775 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

clearSelectedNode

void RPCConsole::clearSelectedNode ( )

privateslot

clear the selected node

Definition at line 1248 of file rpcconsole.cpp.

Here is the caller graph for this function:

cmdRequest

void RPCConsole::cmdRequest ( const QString &  command )

signal

Here is the caller graph for this function:

disconnectSelectedNode

void RPCConsole::disconnectSelectedNode ( )

slot

Disconnect a selected node on the Peers tab.

Definition at line 1182 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

eventFilter()

bool RPCConsole::eventFilter ( QObject *  obj, QEvent *  event  )

protectedvirtual

Definition at line 503 of file rpcconsole.cpp.

Here is the call graph for this function:

fontBigger

void RPCConsole::fontBigger ( )

slot

Definition at line 691 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

fontSmaller

void RPCConsole::fontSmaller ( )

slot

Definition at line 696 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

handleRestart

void RPCConsole::handleRestart ( QStringList  args )

signal

Get restart command-line parameters and handle restart.

Here is the caller graph for this function:

hideEvent

void RPCConsole::hideEvent ( QHideEvent *  event )

privateslot

Definition at line 1157 of file rpcconsole.cpp.

Here is the call graph for this function:

keyPressEvent()

void RPCConsole::keyPressEvent ( QKeyEvent *  event )

protected

Definition at line 825 of file rpcconsole.cpp.

message

void RPCConsole::message ( int  category, const QString &  message, bool  html = false  )

slot

Append the message to the message widget.

Definition at line 833 of file rpcconsole.cpp.

Here is the caller graph for this function:

on_lineEdit_returnPressed

void RPCConsole::on_lineEdit_returnPressed ( )

privateslot

Definition at line 893 of file rpcconsole.cpp.

Here is the call graph for this function:

on_openDebugLogfileButton_clicked

void RPCConsole::on_openDebugLogfileButton_clicked ( )

privateslot

open the debug.log from the current datadir

Definition at line 985 of file rpcconsole.cpp.

Here is the call graph for this function:

on_sldGraphRange_valueChanged

void RPCConsole::on_sldGraphRange_valueChanged ( int  value )

privateslot

change the time range of the network traffic graph

Definition at line 996 of file rpcconsole.cpp.

Here is the call graph for this function:

on_tabWidget_currentChanged

void RPCConsole::on_tabWidget_currentChanged ( int  index )

privateslot

Definition at line 977 of file rpcconsole.cpp.

Here is the call graph for this function:

peerLayoutAboutToChange

void RPCConsole::peerLayoutAboutToChange ( )

slot

Handle selection caching before update.

Definition at line 1027 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

peerLayoutChanged

void RPCConsole::peerLayoutChanged ( )

slot

Handle updated peer information.

Definition at line 1038 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

peerSelected

void RPCConsole::peerSelected ( const QItemSelection &  selected, const QItemSelection &  deselected  )

slot

Handle selection of peer in peers list.

Definition at line 1015 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

resizeEvent

void RPCConsole::resizeEvent ( QResizeEvent *  event )

privateslot

Definition at line 1141 of file rpcconsole.cpp.

RPCExecuteCommandLine()

static bool RPCConsole::RPCExecuteCommandLine ( std::string &  strResult, const std::string &  strCommand, std::string *const  pstrFilteredOut = nullptr  )

inlinestatic

Definition at line 41 of file rpcconsole.h.

Here is the caller graph for this function:

RPCParseCommandLine()

bool RPCConsole::RPCParseCommandLine ( std::string &  strResult, const std::string &  strCommand, bool  fExecute, std::string *const  pstrFilteredOut = nullptr  )

static

Split shell command line into a list of arguments and optionally execute the command(s).

Aims to emulate bash and friends.

• Command nesting is possible with parenthesis; for example: validateaddress(getnewaddress())
• Arguments are delimited with whitespace or comma
• Extra whitespace at the beginning and end and between arguments will be ignored
• Text can be "double" or 'single' quoted
• The backslash \ is used as escape character
  • Outside quotes, any character can be escaped
  • Within double quotes, only escape " and backslashes before a \c " or another backslash
  • Within single quotes, no escaping is possible and no special interpretation takes place

Parameters

[out]	result	stringified Result from the executed command(chain)
[in]	strCommand	Command line to split
[in]	fExecute	set true if you want the command to be executed
[out]	pstrFilteredOut	Command line, filtered to remove any sensitive data

Definition at line 157 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

scrollToEnd

void RPCConsole::scrollToEnd ( )

slot

Scroll console view to end.

Definition at line 990 of file rpcconsole.cpp.

Here is the caller graph for this function:

setClientModel()

void RPCConsole::setClientModel

(

ClientModel *

model

)

Definition at line 547 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setFontSize

void RPCConsole::setFontSize ( int  newSize )

slot

Definition at line 701 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setMempoolSize

void RPCConsole::setMempoolSize ( long  numberOfTxs, size_t  dynUsage  )

slot

Set size (number of transactions and memory usage) of the mempool in the UI.

Definition at line 883 of file rpcconsole.cpp.

Here is the caller graph for this function:

setNetworkActive

void RPCConsole::setNetworkActive ( bool  networkActive )

slot

Set network state shown in the UI.

Definition at line 870 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

setNumBlocks

void RPCConsole::setNumBlocks ( int  count, const QDateTime &  blockDate, double  nVerificationProgress, bool  headers  )

slot

Set number of blocks and last block date shown in the UI.

Definition at line 875 of file rpcconsole.cpp.

Here is the caller graph for this function:

setNumConnections

void RPCConsole::setNumConnections ( int  count )

slot

Set number of connections shown in the UI.

Definition at line 862 of file rpcconsole.cpp.

Here is the caller graph for this function:

setTabFocus

void RPCConsole::setTabFocus ( enum TabTypes  tabType )

slot

set which tab has the focus (is visible)

Definition at line 1266 of file rpcconsole.cpp.

Here is the caller graph for this function:

setTrafficGraphRange()

void RPCConsole::setTrafficGraphRange ( int  mins )

private

Definition at line 1003 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

showBanTableContextMenu

void RPCConsole::showBanTableContextMenu ( const QPoint &  point )

privateslot

Show custom context menu on Bans tab.

Definition at line 1175 of file rpcconsole.cpp.

Here is the caller graph for this function:

showEvent

void RPCConsole::showEvent ( QShowEvent *  event )

privateslot

Definition at line 1146 of file rpcconsole.cpp.

Here is the call graph for this function:

showOrHideBanTableIfRequired

void RPCConsole::showOrHideBanTableIfRequired ( )

privateslot

Hides ban table if no bans are present.

Definition at line 1256 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

showPeersTableContextMenu

void RPCConsole::showPeersTableContextMenu ( const QPoint &  point )

privateslot

Show custom context menu on Peers tab.

Definition at line 1168 of file rpcconsole.cpp.

Here is the caller graph for this function:

startExecutor()

void RPCConsole::startExecutor ( )

private

Definition at line 956 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

stopExecutor

void RPCConsole::stopExecutor ( )

signal

Here is the caller graph for this function:

unbanSelectedNode

void RPCConsole::unbanSelectedNode ( )

slot

Unban a selected node on the Bans tab.

Definition at line 1226 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

updateNetworkState()

void RPCConsole::updateNetworkState ( )

private

Update UI with latest network info from model.

Definition at line 849 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

updateNodeDetail()

void RPCConsole::updateNodeDetail ( const CNodeCombinedStats *  stats )

private

show detailed information on ui about selected node

Definition at line 1095 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

updateTrafficStats

void RPCConsole::updateTrafficStats ( quint64  totalBytesIn, quint64  totalBytesOut  )

privateslot

update traffic statistics

Definition at line 1009 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

walletReindex

void RPCConsole::walletReindex ( )

slot

Restart wallet with "-reindex".

Definition at line 739 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

walletRescan

void RPCConsole::walletRescan ( )

slot

Wallet repair options.

Restart wallet with "-rescan".

Definition at line 727 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

walletZaptxes1

void RPCConsole::walletZaptxes1 ( )

slot

Restart wallet with "-zapwallettxes=1".

Definition at line 733 of file rpcconsole.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

autoCompleter

QCompleter* RPCConsole::autoCompleter

private

Definition at line 164 of file rpcconsole.h.

banTableContextMenu

QMenu* RPCConsole::banTableContextMenu

private

Definition at line 162 of file rpcconsole.h.

cachedNodeids

QList<NodeId> RPCConsole::cachedNodeids

private

Definition at line 158 of file rpcconsole.h.

clientModel

ClientModel* RPCConsole::clientModel

private

Definition at line 154 of file rpcconsole.h.

cmdBeforeBrowsing

QString RPCConsole::cmdBeforeBrowsing

private

Definition at line 157 of file rpcconsole.h.

consoleFontSize

int RPCConsole::consoleFontSize

private

Definition at line 163 of file rpcconsole.h.

history

QStringList RPCConsole::history

private

Definition at line 155 of file rpcconsole.h.

historyPtr

int RPCConsole::historyPtr

private

Definition at line 156 of file rpcconsole.h.

peersTableContextMenu

QMenu* RPCConsole::peersTableContextMenu

private

Definition at line 161 of file rpcconsole.h.

platformStyle

const PlatformStyle* RPCConsole::platformStyle

private

Definition at line 159 of file rpcconsole.h.

rpcTimerInterface

RPCTimerInterface* RPCConsole::rpcTimerInterface

private

Definition at line 160 of file rpcconsole.h.

thread

QThread RPCConsole::thread

private

Definition at line 165 of file rpcconsole.h.

ui

Ui::RPCConsole* RPCConsole::ui

private

Definition at line 153 of file rpcconsole.h.

---

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

• src/qt/rpcconsole.h
• src/qt/rpcconsole.cpp