Struct PackageCacheProxy

pub struct PackageCacheProxy { /* private fields */ }

Implementations

impl PackageCacheProxy

pub fn new(channel: AsyncChannel) -> Self

Create a new Proxy for fuchsia.pkg/PackageCache.

pub fn take_event_stream(&self) -> PackageCacheEventStream

Get a Stream of events from the remote end of the protocol.

Panics

Panics if the event stream was already taken.

pub fn get( &self, meta_far_blob: &BlobInfo, gc_protection: GcProtection, needed_blobs: ServerEnd<NeededBlobsMarker>, dir: ServerEnd<DirectoryMarker>, ) -> QueryResponseFut<PackageCacheGetResult, DefaultFuchsiaResourceDialect>

Gets the package directory if it is present on the local system. If it is not, the missing_blobs iterator will provide all the blobs in the package that are missing from the system, and the ability to write those blobs to blobfs. If all the missing blobs are downloaded and written to by the client, the dir directory will be resolved. This method will return successfully when the package has been fully resolved, or return an error if the client closes needed_blobs or dir handle before the package has been resolved.

This method does not guarantee the missing blobs have been persisted. In order to guarantee missing blobs are persisted, clients should call [‘Sync’].

Clients must not make concurrent Get() calls for the same meta_far_blob, even across different PackageCache connections, unless the meta_far_blob is in base or already active in the dynamic index. Violating this may result in Get() errors.

• request meta_far_blob the blob info for the package’s meta.far.
• request needed_blobs an iterator over all the blobs in the package that are not present on the system.
• request dir the channel on which the package directory will be served.

• error a zx_status value indicating failure. One of the following:
  • ZX_ERR_UNAVAILABLE if the client closed needed_blobs handles before all the missing blobs were downloaded to the system.

pub fn get_subpackage( &self, superpackage: &BlobId, subpackage: &PackageUrl, dir: ServerEnd<DirectoryMarker>, ) -> QueryResponseFut<PackageCacheGetSubpackageResult, DefaultFuchsiaResourceDialect>

Gets the package directory for a subpackage. The connection to the superpackage’s package directory must still be open when this is called. The returned package will be protected by open package tracking.

• request superpackage the hash of the superpackage’s meta.far.
• request subpackage the relative package URL of the subpackage.
• request dir the channel on which the package directory will be served.

• error a GetSubpackageError value indicating failure.

pub fn base_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker>, ) -> Result<(), Error>

Retrieves a chunk iterator to the base package index.

• request iterator a request for the PackageIndexIterator that will return sets of PackageIndexEntry objects until all packages in the base index have been iterated.

pub fn cache_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker>, ) -> Result<(), Error>

Retrieves a chunk iterator to the cache package index.

• request iterator a request for the PackageIndexIterator that will return sets of PackageIndexEntry objects until all packages in the cache index have been iterated.

pub fn sync( &self, ) -> QueryResponseFut<PackageCacheSyncResult, DefaultFuchsiaResourceDialect>

Synchronizes updates to the cached packages to the underlying persistent storage.

• error a zx_status value indicating failure. One of the following:
  • ZX_ERR_INTERNAL if the sync fails.

pub fn set_upgradable_urls( &self, pinned_urls: &[PackageUrl], ) -> QueryResponseFut<PackageCacheSetUpgradableUrlsResult, DefaultFuchsiaResourceDialect>

Sets which package URLs correspond to upgradable packages and the hash they should resolve to.

If upgradable packages are enabled in pkg-cache, this method must be called once on start up to set the hashes for persisted upgradable packages. All such packages must not be base packages. If none of the upgradable packages are persisted, a call with an empty vector still needs to be made. Package resolution of non base packages and GC (and therefore OTA) will block until this is done.

Subsequent calls can be made to set new upgradable packages or change the hashes associated with upgradable packages.

The hash most recently associated with an upgradable package URL will be protected from GC.

• request pinned_urls packages URLs pinned to the new hash.

Trait Implementations

impl Clone for PackageCacheProxy

fn clone(&self) -> PackageCacheProxy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PackageCacheProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PackageCacheProxyInterface for PackageCacheProxy

type GetResponseFut = QueryResponseFut<Result<(), i32>>

type GetSubpackageResponseFut = QueryResponseFut<Result<(), GetSubpackageError>>

type SyncResponseFut = QueryResponseFut<Result<(), i32>>

type SetUpgradableUrlsResponseFut = QueryResponseFut<Result<(), SetUpgradableUrlsError>>

fn get( &self, meta_far_blob: &BlobInfo, gc_protection: GcProtection, needed_blobs: ServerEnd<NeededBlobsMarker>, dir: ServerEnd<DirectoryMarker>, ) -> Self::GetResponseFut

fn get_subpackage( &self, superpackage: &BlobId, subpackage: &PackageUrl, dir: ServerEnd<DirectoryMarker>, ) -> Self::GetSubpackageResponseFut

fn base_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker>, ) -> Result<(), Error>

fn cache_package_index( &self, iterator: ServerEnd<PackageIndexIteratorMarker>, ) -> Result<(), Error>

fn sync(&self) -> Self::SyncResponseFut

fn set_upgradable_urls( &self, pinned_urls: &[PackageUrl], ) -> Self::SetUpgradableUrlsResponseFut

impl Proxy for PackageCacheProxy

type Protocol = PackageCacheMarker

The protocol which this Proxy controls.

fn from_channel(inner: AsyncChannel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Result<AsyncChannel, Self>

Attempt to convert the proxy back into a channel.

fn as_channel(&self) -> &AsyncChannel

Get a reference to the proxy’s underlying channel.

fn into_client_end(self) -> Result<ClientEnd<Self::Protocol>, Self>

Attempt to convert the proxy back into a client end.

fn is_closed(&self) -> bool

Returns true if the proxy has received the PEER_CLOSED signal.

fn on_closed(&self) -> OnSignals<'_, Unowned<'_, Handle>>

Returns a future that completes when the proxy receives the PEER_CLOSED signal.