Page MenuHomePhabricator

final class PhutilAWSS3Future
libphutil Technical Documentation (Futures)

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function isReady()
Inherited

Future

Is this future's process complete? Specifically, can this future be resolved without blocking?

Return
boolIf true, the external process is complete and resolving this future will not block.

public function resolve($timeout)
Inherited

Future

Resolve a future and return its result, blocking until the result is ready if necessary.

Parameters
float$timeoutOptional timeout after which resolution will pause and execution will return to the caller.
Return
mixedFuture result, or null if the timeout is hit.

public function setException($ex)
Inherited

This method is not documented.
Parameters
Exception$ex
Return
wild

public function getException()
Inherited

This method is not documented.
Return
wild

private function checkException()
Inherited

Future

If an exception was set by setException(), throw it.

Return
wild

public function getReadSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become readable while a future is resolving. If your future has sockets which can be select()ed, return them here (or in getWriteSockets()) to make the resolve loop do a select(). If you do not return sockets in either case, you'll get a busy wait.

Return
listA list of sockets which we expect to become readable.

public function getWriteSockets()
Inherited

Future

Retrieve a list of sockets which we can wait to become writable while a future is resolving. See getReadSockets().

Return
listA list of sockets which we expect to become writable.

public static function waitForSockets($read_list, $write_list, $timeout)
Inherited

Future

Wait for activity on one of several sockets.

Parameters
list$read_listList of sockets expected to become readable.
list$write_listList of sockets expected to become writable.
float$timeoutTimeout, in seconds.
Return
void

public static function handleSIGCHLD($signo)
Inherited

This method is not documented.
Parameters
$signo
Return
wild

protected function getResult()
Inherited

Future

Retrieve the final result of the future. This method will be called after the future is ready (as per isReady()) but before results are passed back to the caller. The major use of this function is that you can override it in subclasses to do postprocessing or error checking, which is particularly useful if building application-specific futures on top of primitive transport futures (like CurlFuture and ExecFuture) which can make it tricky to hook this logic into the main pipeline.

Return
mixedFinal resolution of this future.

public function getDefaultWait()
Inherited

Future

Default amount of time to wait on stream select for this future. Normally 1 second is fine, but if the future has a timeout sooner than that it should return the amount of time left before the timeout.

Return
wild

public function start()
Inherited

This method is not documented.
Return
wild

public function __construct()
Inherited

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

public function setProxiedFuture($proxied)
Inherited

This method is not documented.
Parameters
Future$proxied
Return
wild

protected function getProxiedFuture()
Inherited

This method is not documented.
Return
wild

protected function didReceiveResult($result)

This method is not documented.
Parameters
$result
Return
wild

public function getServiceName()

This method is not documented.
Return
wild

public function setAccessKey($access_key)
Inherited

This method is not documented.
Parameters
$access_key
Return
wild

public function getAccessKey()
Inherited

This method is not documented.
Return
wild

public function setSecretKey($secret_key)
Inherited

This method is not documented.
Parameters
PhutilOpaqueEnvelope$secret_key
Return
wild

public function getSecretKey()
Inherited

This method is not documented.
Return
wild

public function getRegion()
Inherited

This method is not documented.
Return
wild

public function setRegion($region)
Inherited

This method is not documented.
Parameters
$region
Return
wild

public function setEndpoint($endpoint)
Inherited

This method is not documented.
Parameters
$endpoint
Return
wild

public function getEndpoint()
Inherited

This method is not documented.
Return
wild

public function setHTTPMethod($method)
Inherited

This method is not documented.
Parameters
$method
Return
wild

public function getHTTPMethod()
Inherited

This method is not documented.
Return
wild

public function setPath($path)
Inherited

This method is not documented.
Parameters
$path
Return
wild

public function getPath()
Inherited

This method is not documented.
Return
wild

public function setData($data)
Inherited

This method is not documented.
Parameters
$data
Return
wild

public function getData()
Inherited

This method is not documented.
Return
wild

protected function getParameters()
Inherited

This method is not documented.
Return
wild

public function addHeader($key, $value)
Inherited

This method is not documented.
Parameters
$key
$value
Return
wild

protected function signRequest($future)
Inherited

This method is not documented.
Parameters
HTTPSFuture$future
Return
wild

protected function shouldSignContent()

This method is not documented.
Return
wild

public function setBucket($bucket)

This method is not documented.
Parameters
$bucket
Return
wild

public function getBucket()

This method is not documented.
Return
wild

public function setParametersForGetObject($key)

This method is not documented.
Parameters
$key
Return
wild

public function setParametersForPutObject($key, $value)

This method is not documented.
Parameters
$key
$value
Return
wild

public function setParametersForDeleteObject($key)

This method is not documented.
Parameters
$key
Return
wild