class RemoteStatus (View source)

Represents status of remote end

Properties

protected bool $isReady
protected string $message
protected array $meta

Methods

__construct(bool $isReady, string $message, array $meta = [])

No description

static RemoteStatus
createFromResponse(array $responseBody)

No description

bool
isReady()

The remote end's readiness state.

string
getMessage()

An implementation-defined string explaining the remote end's readiness state.

array
getMeta()

Arbitrary meta information specific to remote-end implementation.

setMeta(array $meta)

No description

Details

protected __construct(bool $isReady, string $message, array $meta = [])

No description

Parameters

bool $isReady
string $message
array $meta

static RemoteStatus createFromResponse(array $responseBody)

No description

Parameters

array $responseBody

Return Value

RemoteStatus

bool isReady()

The remote end's readiness state.

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 Value

bool

string getMessage()

An implementation-defined string explaining the remote end's readiness state.

Return Value

string

array getMeta()

Arbitrary meta information specific to remote-end implementation.

Return Value

array

protected setMeta(array $meta)

No description

Parameters

array $meta