class HealthClient extends BaseClient

Constants

private DEFAULT_WRITE_TIMEOUT

private RESERVED_TIMEOUT_HEADER

private OPTION_KEYS

private CALL_OPTION_KEYS

private TLS_OPTION_KEYS

private TLS_ONLY_OPTION_KEYS

Methods

__construct(string $target, array $options = [])

Create a reusable generated-style gRPC client.

string
target()

Return the configured endpoint target.

void
close()

Close every connection owned by this client.

_simpleRequest(string $method, Message $argument, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a unary request.

_clientStreamRequest(string $method, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a client-streaming request.

_serverStreamRequest(string $method, Message $argument, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a server-streaming request.

_bidiRequest(string $method, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a bidirectional-streaming request.

prepareMetadata(array|Metadata $metadata)

Prepare metadata for a new RPC.

check(HealthCheckRequest $request, array|Metadata $metadata = [], array $options = [])

Check the health of one service.

list(HealthListRequest $request, array|Metadata $metadata = [], array $options = [])

List every known service health status.

watch(HealthCheckRequest $request, array|Metadata $metadata = [], array $options = [])

Watch health status changes for one service.

Details

in BaseClient at line 115
__construct(string $target, array $options = [])

Create a reusable generated-style gRPC client.

Parameters

string $target
array $options

in BaseClient at line 206
string target()

Return the configured endpoint target.

Return Value

string

in BaseClient at line 214
void close()

Close every connection owned by this client.

Return Value

void

in BaseClient at line 246
protected UnaryCall _simpleRequest(string $method, Message $argument, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a unary request.

Parameters

string $method
Message $argument
array|callable $deserialize
array|Metadata $metadata
array $options

Return Value

UnaryCall

in BaseClient at line 295
protected ClientStreamingCall _clientStreamRequest(string $method, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a client-streaming request.

Parameters

string $method
array|callable $deserialize
array|Metadata $metadata
array $options

Return Value

ClientStreamingCall

in BaseClient at line 334
protected ServerStreamingCall _serverStreamRequest(string $method, Message $argument, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a server-streaming request.

Parameters

string $method
Message $argument
array|callable $deserialize
array|Metadata $metadata
array $options

Return Value

ServerStreamingCall

in BaseClient at line 383
protected BidiStreamingCall _bidiRequest(string $method, array|callable $deserialize, array|Metadata $metadata = [], array $options = [])

Start a bidirectional-streaming request.

Parameters

string $method
array|callable $deserialize
array|Metadata $metadata
array $options

Return Value

BidiStreamingCall

in BaseClient at line 420
protected Metadata prepareMetadata(array|Metadata $metadata)

Prepare metadata for a new RPC.

Parameters

array|Metadata $metadata

Return Value

Metadata

at line 24
UnaryCall check(HealthCheckRequest $request, array|Metadata $metadata = [], array $options = [])

Check the health of one service.

Parameters

HealthCheckRequest $request
array|Metadata $metadata
array $options

Return Value

UnaryCall

at line 44
UnaryCall list(HealthListRequest $request, array|Metadata $metadata = [], array $options = [])

List every known service health status.

Parameters

HealthListRequest $request
array|Metadata $metadata
array $options

Return Value

UnaryCall

at line 64
ServerStreamingCall watch(HealthCheckRequest $request, array|Metadata $metadata = [], array $options = [])

Watch health status changes for one service.

Parameters

HealthCheckRequest $request
array|Metadata $metadata
array $options

Return Value

ServerStreamingCall