Page MenuHomePhabricator

final class ConduitClient
libphutil Technical Documentation (Conduit)

This class is not documented.

Methods

public function getConnectionID()

This method is not documented.
Return
wild

public function __construct($uri)

This method is not documented.
Parameters
$uri
Return
this//Implicit.//

public function setHost($host)

Override the domain specified in the service URI and provide a specific host identity.

This can be used to connect to a specific node in a cluster environment.

Parameters
$host
Return
wild

public function getHost()

This method is not documented.
Return
wild

public function setConduitToken($conduit_token)

This method is not documented.
Parameters
$conduit_token
Return
wild

public function getConduitToken()

This method is not documented.
Return
wild

public function setOAuthToken($oauth_token)

This method is not documented.
Parameters
$oauth_token
Return
wild

public function callMethodSynchronous($method, $params)

This method is not documented.
Parameters
$method
array$params
Return
wild

public function didReceiveResponse($method, $data)

This method is not documented.
Parameters
$method
$data
Return
wild

public function setTimeout($timeout)

This method is not documented.
Parameters
$timeout
Return
wild

public function setSigningKeys($public_key, $private_key)

This method is not documented.
Parameters
$public_key
PhutilOpaqueEnvelope$private_key
Return
wild

public function enableCapabilities($capabilities)

This method is not documented.
Parameters
array$capabilities
Return
wild

public function callMethod($method, $params)

This method is not documented.
Parameters
$method
array$params
Return
wild

public function setBasicAuthCredentials($username, $password)

This method is not documented.
Parameters
$username
$password
Return
wild

private function getHostStringForHeader()

This method is not documented.
Return
wild

private function getHostStringForSignature()

This method is not documented.
Return
wild

private function newHostString($with_explicit_port)

Build a string describing the host for this request.

This method builds strings in two modes: with explicit ports for request signing (which always include the port number) and with implicit ports for use in the "Host:" header of requests (which omit the port number if the port is the same as the default port for the protocol).

This implicit port behavior is similar to what browsers do, so it is less likely to get us into trouble with webserver configurations.

Parameters
bool$with_explicit_portTrue to include the port explicitly.
Return
stringString describing the host for the request.

private function signRequest($method, $params, $meta)

This method is not documented.
Parameters
$method
array$params
array$meta
Return
wild

public static function verifySignature($method, $params, $meta, $openssl_public_key)

This method is not documented.
Parameters
$method
array$params
array$meta
$openssl_public_key
Return
wild

private static function encodeRequestDataForSignature($method, $params, $meta)

This method is not documented.
Parameters
$method
array$params
array$meta
Return
wild

public static function encodeRawDataForSignature($data)

This method is not documented.
Parameters
$data
Return
wild