<?php /** * Copyright 2018 Google Inc. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ namespace Google\Cloud\Core\Batch; use Google\Cloud\Core\SysvTrait; /** * A trait to assist in the registering and processing of simple jobs. * * @experimental The experimental flag means that while we believe this method * or class is ready for use, it may change before release in backwards- * incompatible ways. Please use with caution, and test thoroughly when * upgrading. */ trait SimpleJobTrait { use BatchDaemonTrait; use SysvTrait; use SerializableClientTrait; /** * The simple loop function. This method is expected to be a blocking call. */ abstract public function run(); /** * Registers this object as a SimpleJob. * * @param array $options [optional] { * Configuration options. * * @type string $identifier An identifier for the simple job. This * value must be unique across all job configs. * @type ConfigStorageInterface $configStorage The configuration storage * used to save configuration. * @type int $numWorkers The number of workers for this job. * @type array $clientConfig A config used to construct the client upon * which requests will be made. * @type ClosureSerializerInterface $closureSerializer An implementation * responsible for serializing closures used in the * `$clientConfig`. This is especially important when using the * batch daemon. **Defaults to** * {@see Google\Cloud\Core\Batch\OpisClosureSerializer} if the * `opis/closure` library is installed. * } */ private function setSimpleJobProperties(array $options = []) { if (!isset($options['identifier'])) { throw new \InvalidArgumentException( 'A valid identifier is required in order to register a job.' ); } $options += [ 'configStorage' => null, ]; $this->setSerializableClientOptions($options); $identifier = $options['identifier']; $configStorage = $options['configStorage'] ?: $this->defaultConfigStorage(); $result = $configStorage->lock(); if ($result === false) { return false; } $config = $configStorage->load(); $config->registerJob( $identifier, function ($id) use ($identifier, $options) { return new SimpleJob($identifier, [$this, 'run'], $id, $options); } ); try { $result = $configStorage->save($config); } finally { $configStorage->unlock(); } return $result; } private function defaultConfigStorage() { if ($this->isSysvIPCLoaded() && $this->isDaemonRunning()) { return new SysvConfigStorage(); } else { return InMemoryConfigStorage::getInstance(); } } }
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
BatchDaemon.php | File | 5.36 KB | 0644 |
|
BatchDaemonTrait.php | File | 1.31 KB | 0644 |
|
BatchJob.php | File | 6.01 KB | 0644 |
|
BatchRunner.php | File | 6.17 KB | 0644 |
|
BatchTrait.php | File | 6.45 KB | 0644 |
|
ClosureSerializerInterface.php | File | 1.25 KB | 0644 |
|
ConfigStorageInterface.php | File | 1.65 KB | 0644 |
|
HandleFailureTrait.php | File | 3.01 KB | 0644 |
|
InMemoryConfigStorage.php | File | 5.41 KB | 0644 |
|
InterruptTrait.php | File | 1.89 KB | 0644 |
|
JobConfig.php | File | 3.07 KB | 0644 |
|
JobInterface.php | File | 1.55 KB | 0644 |
|
JobTrait.php | File | 2.29 KB | 0644 |
|
OpisClosureSerializer.php | File | 1.66 KB | 0644 |
|
ProcessItemInterface.php | File | 1.42 KB | 0644 |
|
QueueOverflowException.php | File | 1.12 KB | 0644 |
|
Retry.php | File | 2.27 KB | 0644 |
|
SerializableClientTrait.php | File | 3.12 KB | 0644 |
|
SimpleJob.php | File | 2.31 KB | 0644 |
|
SimpleJobTrait.php | File | 3.52 KB | 0644 |
|
SysvConfigStorage.php | File | 4.61 KB | 0644 |
|
SysvProcessor.php | File | 2.8 KB | 0644 |
|