GRPC PHP  1.38.0
Public Member Functions
Grpc\Call Class Reference

class Call More...

Public Member Functions

 __construct ($channel_obj, $method, $deadline_obj, $host_override="")
 Constructs a new instance of the Call class. More...
 
 startBatch ($array)
 Start a batch of RPC actions. More...
 
 getPeer ()
 Get the endpoint this call/stream is connected to. More...
 
 cancel ()
 Cancel the call. More...
 
 setCredentials ($creds_obj)
 Set the CallCredentials for this call. More...
 

Detailed Description

class Call

See also
https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/call.c

Constructor & Destructor Documentation

◆ __construct()

Grpc\Call::__construct (   $channel_obj,
  $method,
  $deadline_obj,
  $host_override = "" 
)

Constructs a new instance of the Call class.

Parameters
Channel$channel_objThe channel to associate the call with. Must not be closed.
string$methodThe method to call
Timeval$deadline_objThe deadline for completing the call
string$host_override= "" The host is set by user (optional)

Member Function Documentation

◆ cancel()

Grpc\Call::cancel ( )

Cancel the call.

This will cause the call to end with STATUS_CANCELLED if it has not already ended with another status.

Returns
void

◆ getPeer()

Grpc\Call::getPeer ( )

Get the endpoint this call/stream is connected to.

Returns
string The URI of the endpoint

◆ setCredentials()

Grpc\Call::setCredentials (   $creds_obj)

Set the CallCredentials for this call.

Parameters
CallCredentials$creds_objThe CallCredentials object
Returns
int The error code

◆ startBatch()

Grpc\Call::startBatch (   $array)

Start a batch of RPC actions.

Parameters
array$arrayArray of actions to take
Returns
object Object with results of all actions

The documentation for this class was generated from the following file: