RemoteStatus
in package
Represents status of remote end
Tags
Table of Contents
Properties
Methods
- createFromResponse() : RemoteStatus
- getMessage() : string
- An implementation-defined string explaining the remote end's readiness state.
- getMeta() : array<string|int, mixed>
- Arbitrary meta information specific to remote-end implementation.
- isReady() : bool
- The remote end's readiness state.
- __construct() : mixed
- setMeta() : mixed
Properties
$isReady
protected
bool
$isReady
$message
protected
string
$message
$meta
protected
array<string|int, mixed>
$meta
= []
Methods
createFromResponse()
public
static createFromResponse(array<string|int, mixed> $responseBody) : RemoteStatus
Parameters
- $responseBody : array<string|int, mixed>
Return values
RemoteStatusgetMessage()
An implementation-defined string explaining the remote end's readiness state.
public
getMessage() : string
Return values
stringgetMeta()
Arbitrary meta information specific to remote-end implementation.
public
getMeta() : array<string|int, mixed>
Return values
array<string|int, mixed>isReady()
The remote end's readiness state.
public
isReady() : bool
False if an attempt to create a session at the current time would fail. However, the value true does not guarantee that a New Session command will succeed.
Return values
bool__construct()
protected
__construct(bool $isReady, string $message[, array<string|int, mixed> $meta = [] ]) : mixed
Parameters
- $isReady : bool
- $message : string
- $meta : array<string|int, mixed> = []
setMeta()
protected
setMeta(array<string|int, mixed> $meta) : mixed
Parameters
- $meta : array<string|int, mixed>