visor

Type Members

type Arg = (String, String)

Argument type.
type ArgList = Seq[Arg]

Type alias for command argument list.
type EventFilter = (GridEvent) ⇒ Boolean

Type alias for general event filter.
type NodeFilter = (GridNode) ⇒ Boolean

Type alias for general node filter.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final val ALL_NODES_FILTER: (GridNode) ⇒ Boolean

Node filter that includes any node.
final val NL: String

System line separator.
val Til: Arg

Nil is for empty list, Til is for empty tuple.
def addCloseCallback(f: () ⇒ Unit): Unit

Adds close callback.
Adds close callback. Added function will be called every time command close is called.
f
Close callback to add.
def addHelp(name: String, shortInfo: String, longInfo: Seq[String] = null, aliases: Seq[String] = Seq.empty, spec: Seq[String], args: Seq[(String, AnyRef)] = null, examples: Seq[(String, AnyRef)], ref: VisorConsoleCommand): Unit

Adds command help to the Visor console.
Adds command help to the Visor console. This will be printed as part of help command.
name
Command name.
shortInfo
Short command description.
longInfo
Optional multi-line long command description. If not provided - short description will be used instead.
aliases
List of aliases. Optional.
spec
Command specification.
args
List of (host, description) tuples for command arguments. Optional.
examples
List of (example, description) tuples for command examples.
ref
- command implementation.
def addShutdownCallback(f: () ⇒ Unit): Unit

Adds close callback.
Adds close callback. Added function will be called every time command close is called.
f
Close callback to add.
def adviseToConnect(): Unit

Prints standard 'not connected' error message.
def apply(): Unit

Prints out status and help in case someone calls visor().
def argName(t: (String, String)): String

Helper function that makes up the full argument host from tuple.
Helper function that makes up the full argument host from tuple.
t
Command argument tuple.
def argValue(n: String, args: ArgList): Option[String]

Gets the value for a given argument host.
Gets the value for a given argument host.
n
Argument host.
args
Argument list.
returns
Argument value.

Annotations
@Nullable()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def ask(prompt: String, dflt: String, passwd: Boolean = false): String

Asks user input.
Asks user input.
prompt
Prompt string.
dflt
Default value for user input.
passwd
If true, input will be masked with '*' character. false by default.
def askConfigFile(): Option[String]

Asks user to choose configuration file.
Asks user to choose configuration file.
returns
Option for file path.
def askForHost(title: String): Option[GridProjection]

Asks user to select a host from the list.
Asks user to select a host from the list.
title
Title displayed before the list of hosts.
returns
Option for projection of nodes located on selected host.
def askForNode(title: String): Option[UUID]

Asks user to select a node from the list.
Asks user to select a node from the list.
title
Title displayed before the list of nodes.
returns
Option for ID of selected node.
def askNodeId(): Option[String]

Asks user to choose node id8.
Asks user to choose node id8.
returns
Option for node id8.
var cfgPath: String

Configuration file path, if any.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Disconnects visor.
Command
Disconnects visor.
Examples
<ex>close</ex> Disconnects from the grid.
lazy val commands: Seq[String]
def connectTimestamp: Long

Gets timestamp of Visor console connection.
Gets timestamp of Visor console connection. Returns 0 if Visor console is not connected.
returns
Timestamp of Visor console connection.
def emptyTaskArgument[A](nids: Iterable[UUID]): GridBiTuple[Set[UUID], Void]
def emptyTaskArgument[A](nid: UUID): GridBiTuple[Set[UUID], Void]

Convert to task argument.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def formatDate(date: Date): String

Returns string representation of the date provided.
Returns string representation of the date provided. Result formatted using pattern MM/dd/yy.
date
Date.
def formatDate(ts: Long): String

Returns string representation of the timestamp provided.
Returns string representation of the timestamp provided. Result formatted using pattern MM/dd/yy.
ts
Timestamp.
def formatDateTime(date: Date): String

Returns string representation of the date provided.
Returns string representation of the date provided. Result formatted using pattern MM/dd/yy, HH:mm:ss.
date
Date.
def formatDateTime(ts: Long): String

Returns string representation of the timestamp provided.
Returns string representation of the timestamp provided. Result formatted using pattern MM/dd/yy, HH:mm:ss.
ts
Timestamp.
def formatDouble(d: Double): String

Formats double value with #0.00 formatter.
Formats double value with #0.00 formatter.
d
Double value to format.
def formatInt(d: Double): String

Formats double value with #0 formatter.
Formats double value with #0 formatter.
d
Double value to format.
def formatMemory(n: Long): String

Returns string representation of the memory.
Returns string representation of the memory.
n
Memory size.
def formatMemoryLimit(n: Long): String

Returns string representation of the memory limit.
Returns string representation of the memory limit.
n
Memory size.
def formatNumber(n: Long): String

Returns string representation of the number.
Returns string representation of the number.
n
Number.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getVariable(v: String): String

Try get variable value with given name.
Try get variable value with given name.
v
variable name.
returns
variable value or v if variable with name v not exist.
var grid: GridEx
def gridOpt: Option[GridEx]

Gets global projection as an option.
def hasArgFlag(n: String, args: ArgList): Boolean

Shortcut method that checks if flag (non-null host and null value) is set in the argument list.
Shortcut method that checks if flag (non-null host and null value) is set in the argument list.
n
Name of the flag.
args
Command argument list.
def hasArgName(n: String, args: ArgList): Boolean

Shortcut method that checks if passed in argument list has an argument with given host.
Shortcut method that checks if passed in argument list has an argument with given host.
n
Argument host to check for existence in this list.
args
Command argument list.
def hasArgValue(v: String, args: ArgList): Boolean

Shortcut method that checks if passed in argument list has an argument with given value.
Shortcut method that checks if passed in argument list has an argument with given value.
v
Argument value to check for existence in this list.
args
Command argument list.
def hashCode(): Int

Definition Classes
AnyRef → Any
def help(): Unit

Prints generic help.
Command
Prints generic help.
Example
<ex>help</ex> Prints help.
def help(args: String = null): Unit

Prints help for specific command(s) or for all commands.
Command
Prints help for specific command(s) or for all commands.
Example
<ex>help</ex> Prints general help.
<ex>help open</ex> Prints help for 'open' command.
args
List of commands to print help for. If empty - prints generic help.
def isConnected: Boolean

Tests whether or not Visor console is connected.
Tests whether or not Visor console is connected.
returns
True if Visor console is connected.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def log(args: String): Unit

Starts or stops logging.
Command
Starts or stops logging.
Examples
<ex>log -l -f=/home/user/visor-log</ex> Starts logging to file visor-log located at /home/user.
<ex>log -l -f=log/visor-log</ex> Starts logging to file visor-log located at &ltGridGain home folder&gt/log.
<ex>log -l -p=20</ex> Starts logging with querying events period of 20 seconds.
<ex>log -l -t=30</ex> Starts logging with topology snapshot logging period of 30 seconds.
<ex>log -s</ex> Stops logging.
args
Command arguments.
def log(): Unit

Prints log status.
Command
Prints log status.
Examples
<ex>log</ex> Prints log status.
def logText(msg: String): Unit

Logs text message.
Logs text message.
msg
Message to log.
def makeArg(arg: Arg): String

Reconstructs string presentation for given argument.
Reconstructs string presentation for given argument.
arg
Argument to reconstruct.

Annotations
@Nullable()
def makeArgs(args: ArgList): String

Reconstructs string presentation for given argument list.
Reconstructs string presentation for given argument list.
args
Argument list to reconstruct.
def makeExpression(s: String): Option[(Long) ⇒ Boolean]

Parses string containing mnemonic predicate and returns Scala predicate.
Parses string containing mnemonic predicate and returns Scala predicate.
s
Mnemonic predicate.
returns
Long to Boolean predicate or null if predicate cannot be created.
def mclear(): Unit

Clears all Visor console memory.
def mclear(arg: String): Unit

Clears given Visor console variable or the whole namespace.
Clears given Visor console variable or the whole namespace.
arg
Variable host or namespace mnemonic.
def mfind(v: String): Option[(String, String)]

Finds variable by its value.
Finds variable by its value.
v
Value to find by.
def mget(): Unit

Trap for missing arguments.
def mget(n: String): Unit

Gets Visor console memory variable.
Command
Gets Visor console memory variable. Note that this method does not perform variable substitution on its parameters.
Examples
<ex>mget @a</ex> Gets the value for Visor console variable '@a'.
n
Name of the variable.
returns
Variable value or null if such variable doesn't exist or its value was set as null.
def mgetOpt(n: String): Option[String]

Gets Visor console memory variable.
Command
Gets Visor console memory variable. Note that this method does not perform variable substitution on its parameters.
Examples
<ex>mgetOpt a</ex> Gets the value as an option for Visor console variable 'a'.
n
Name of the variable.
returns
Variable host as an option.
def mlist(): Unit

Lists all Visor console memory.
Command
Lists all Visor console memory.
Examples
<ex>mlist</ex> Lists all variables in Visor console memory.
def mlist(arg: String): Unit

Lists Visor console memory variables.
Command
Lists Visor console memory variables.
Examples
<ex>mlist ac</ex> Lists variables that start with a or c from Visor console memory.
<ex>mlist</ex> Lists all variables from Visor console memory.
arg
String that contains start characters of listed variables. If empty - all variables will be listed.
def mset(n: String, v: String): String

Sets Visor console memory variable.
Sets Visor console memory variable. Note that this method does not perform variable substitution on its parameters.
n
Name of the variable. Can't be null.
v
Value of the variable. Can't be null.
returns
Previous value.
def msetOpt(n: String, v: String): Option[String]

Sets Visor console memory variable.
Sets Visor console memory variable. Note that this method does not perform variable substitution on its parameters.
n
Name of the variable. Can't be null.
v
Value of the variable. Can't be null.
returns
Previous value as an option.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nid8(nid: UUID): String

Transform node ID to ID8 string.
Transform node ID to ID8 string.
nid
Node ID.
returns
Node ID in ID8 format.
def nid8(node: GridNode): String

Transform node ID to ID8 string.
Transform node ID to ID8 string.
node
Node to take ID from.
returns
Node ID in ID8 format.
def nl(): Unit

Shortcut for println().
def node(nid: UUID): GridNode

Get grid node for specified ID.
Get grid node for specified ID.
nid
Node ID.
returns
GridNode instance.

Exceptions thrown
GridException
if Visor is disconnected or node not found.
def nodeById8(id8: String): Iterable[GridNode]

Get node by ID8 string.
Get node by ID8 string.
id8
Node ID in ID8 format.
returns
Collection of nodes that has specified ID8.
def nodeId8(id: UUID): String

Returns string with node id8 and its memory variable, if available.
Returns string with node id8 and its memory variable, if available.
id
Node ID.
returns
String.
def nodeId8Addr(id: UUID): String

Returns string with node id8, its memory variable, if available, and its IP address (first internal address), if node is alive.
Returns string with node id8, its memory variable, if available, and its IP address (first internal address), if node is alive.
id
Node ID.
returns
String.
def noop(): Unit
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def open(): Unit

Connects Visor console to the default grid.
Command
Connects Visor console to the default grid.
Example
<ex>open</ex> Connects to the default grid.
def open(cfg: GridConfiguration, cfgPath: String): Unit

Connects Visor console to configuration with path.
Connects Visor console to configuration with path.
cfg
Configuration.
cfgPath
Configuration path.
def open(args: String): Unit

Connects Visor console to default or named grid.
Command
Connects Visor console to default or named grid.
Examples
<ex>open -g=mygrid</ex> Connects to 'mygrid' grid.
args
Command arguments.
def parseArgs(args: String): ArgList

Utility method that parses command arguments.
Utility method that parses command arguments. Arguments represented as a string into argument list represented as list of tuples (host, value) performing variable substitution:
-p=@n - A named parameter where @n will be considered as a reference to variable named n. @ n - An unnamed parameter where @n will be considered as a reference to variable named n. -p - A flag doesn't support variable substitution.
Note that recursive substitution isn't supported. If specified variable isn't set - the value starting with @ will be used as-is.
args
Command arguments to parse.
def parseNode(argLst: ArgList): Product with Serializable with Either[String, Option[GridNode]]

Extract node from command arguments.
Extract node from command arguments.
argLst
Command arguments.
returns
error message or node ref.
var pool: ExecutorService

Internal thread pool.
def quit(): Unit

quit from Visor console.
Command
quit from Visor console.
Examples
<ex>quit</ex> Quit from Visor console.
def removeCloseCallback(f: () ⇒ Unit): Unit

Removes close callback.
Removes close callback.
f
Close callback to remove.
def removeCloseCallbacks(): Unit

Removes all close callbacks.
def safe(a: Any, dflt: Any = ""): String

Gets a non-null value for given parameter.
Gets a non-null value for given parameter.
a
Parameter.
dflt
Value to return if a is null.
def safePercent(v: Double): String

Guards against invalid percent readings.
Guards against invalid percent readings.
v
Value in '%' to guard. Any value below 0 and greater than 100 will return n/a string.
def searchCmd(cmd: String): Option[VisorConsoleCommandHolder]
def setVar(v: AnyRef, prefix: String): String

Creates a new variable with given value and returns its host.
Creates a new variable with given value and returns its host.
v
Value.
prefix
Variable host prefix.
returns
New variable host.
def setVarIfAbsent(v: AnyRef, prefix: String): String

If variable with given value and prefix doesn't exist - creates a new variable with given value and returns its host.
If variable with given value and prefix doesn't exist - creates a new variable with given value and returns its host. Otherwise, returns an existing variable host.
v
Value.
prefix
Variable host prefix.
returns
Existing variable host or the new variable host.
def status(): Unit

Prints Visor console status (with ASCII logo).
Command
Prints Visor console status (with ASCII logo).
Example
<ex>status</ex> Prints Visor console status.
def status(args: String): Unit

Prints Visor console status.
Command
Prints Visor console status.
Example
<ex>status -q</ex> Prints Visor console status without ASCII logo.
args
Optional "-q" flag to disable ASCII logo printout.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def timeFilter(timeArg: Option[String]): Long

Decode time frame from string.
Decode time frame from string.
timeArg
Optional time frame: <num>s|m|h|d
returns
Time in milliseconds.
implicit def toReturnable(v: Any): AnyRef { def ^^: Unit }

Introduction of ^^ operator for Any type that will call break.
Introduction of ^^ operator for Any type that will call break.
v
Any value.
def toString(): String

Definition Classes
AnyRef → Any
def toTaskArgument[A](nids: Iterable[UUID], arg: A): GridBiTuple[Set[UUID], A]

Convert to task argument.
def toTaskArgument[A](nid: UUID, arg: A): GridBiTuple[Set[UUID], A]

Convert to task argument.
def uptime: Long

Gets visor uptime.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def warn(errMsgs: Any*): Unit

Prints properly formatted error message like:
Prints properly formatted error message like:
```
<visor>: err: error message
```
errMsgs
Error messages to print. If null - this function is no-op.

object visor extends VisorTag

Overview

Usage

Type Members

type Arg = (String, String)

type ArgList = Seq[Arg]

type EventFilter = (GridEvent) ⇒ Boolean

type NodeFilter = (GridNode) ⇒ Boolean

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final val ALL_NODES_FILTER: (GridNode) ⇒ Boolean

final val NL: String

val Til: Arg

def addCloseCallback(f: () ⇒ Unit): Unit

def addHelp(name: String, shortInfo: String, longInfo: Seq[String] = null, aliases: Seq[String] = Seq.empty, spec: Seq[String], args: Seq[(String, AnyRef)] = null, examples: Seq[(String, AnyRef)], ref: VisorConsoleCommand): Unit

def addShutdownCallback(f: () ⇒ Unit): Unit

def adviseToConnect(): Unit

def apply(): Unit

def argName(t: (String, String)): String

def argValue(n: String, args: ArgList): Option[String]

final def asInstanceOf[T0]: T0

def ask(prompt: String, dflt: String, passwd: Boolean = false): String

def askConfigFile(): Option[String]

def askForHost(title: String): Option[GridProjection]

def askForNode(title: String): Option[UUID]

def askNodeId(): Option[String]

var cfgPath: String

def clone(): AnyRef

def close(): Unit

Command

Examples

lazy val commands: Seq[String]

def connectTimestamp: Long

def emptyTaskArgument[A](nids: Iterable[UUID]): GridBiTuple[Set[UUID], Void]

def emptyTaskArgument[A](nid: UUID): GridBiTuple[Set[UUID], Void]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def formatDate(date: Date): String

def formatDate(ts: Long): String

def formatDateTime(date: Date): String

def formatDateTime(ts: Long): String

def formatDouble(d: Double): String

def formatInt(d: Double): String

def formatMemory(n: Long): String

def formatMemoryLimit(n: Long): String

def formatNumber(n: Long): String

final def getClass(): Class[_]

def getVariable(v: String): String

var grid: GridEx

def gridOpt: Option[GridEx]

def hasArgFlag(n: String, args: ArgList): Boolean

def hasArgName(n: String, args: ArgList): Boolean

def hasArgValue(v: String, args: ArgList): Boolean

def hashCode(): Int

def help(): Unit

Command

Example

def help(args: String = null): Unit

Command

Example

def isConnected: Boolean

final def isInstanceOf[T0]: Boolean

def log(args: String): Unit

Command

Examples

def log(): Unit

Command

Examples

def logText(msg: String): Unit

def makeArg(arg: Arg): String

def makeArgs(args: ArgList): String

def makeExpression(s: String): Option[(Long) ⇒ Boolean]

def mclear(): Unit

def mclear(arg: String): Unit

def mfind(v: String): Option[(String, String)]

def mget(): Unit