\WebConsoleRPCServer
Synopsis
class WebConsoleRPCServer
extends BaseJsonRpcServer
{
- // Inherited constants from BaseJsonRpcServer
- const ParseError = 32700;
- // members
- protected string $home_directory = '';
- // Inherited members from BaseJsonRpcServer
- protected array $instances;
- protected object|array $request;
- protected array $calls;
- protected array $response;
- protected bool $hasCalls;
- protected array $hiddenMethods;
- public string $ContentType;
- public bool $IsXDR;
- public integer $MaxBatchCalls;
- protected array $errorMessages;
- // methods
- private void error()
- private void authenticate_user()
- private void authenticate_token()
- private void get_home_directory()
- private void get_environment()
- private void set_environment()
- private void initialize()
- public void login()
- public void cd()
- public void completion()
- public void run()
- public array stream()
- public array stream_update()
- // Inherited methods from BaseJsonRpcServer
- public void __construct()
- public $this RegisterInstance()
- public void Execute()
Hierarchy
Extends
Constants
Name | Value |
---|---|
ParseError | 32700 |
Members
protected
- $calls
—
array
Array of Received Calls - $errorMessages
—
array
Error Messages - $hasCalls
—
bool
Has Calls Flag (not notifications) - $home_directory
- $instances
—
array
Exposed Instances - $request
—
object|array
Decoded Json Request - $response
—
array
Array of Responses for Calls
public
- $ContentType
—
string
Content Type - $IsXDR
—
bool
Allow Cross-Domain Requests - $MaxBatchCalls
—
int
Max Batch Calls
Methods
private
- authenticate_token()
- authenticate_user()
- error()
- get_environment()
- get_home_directory()
- initialize()
- set_environment()
public
- cd()
- completion()
- login()
- run()
- stream() — Like "run" but returns a token for streaming subsequent output, rather than blockind and returning the output
- stream_update() — Get update content for a long-running task
Inherited from BaseJsonRpcServer
public
- Execute() — Handle Requests
- RegisterInstance() — Register Instance