util

Documentation

Overview

Package util provides utility functions for OSD servers and drivers. Copyright 2017 Portworx

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.

Package sdk is the gRPC implementation of the SDK gRPC server Copyright 2018 Portworx

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.

Index

• func VolumeFromIdSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, id string) (*api.Volume, error)
• func VolumeFromName(v volume.VolumeDriver, name string) (*api.Volume, error)
• func VolumeFromNameSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, name string) (*api.Volume, error)
• func VolumeIdFromNameSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, name string) (string, error)
• func WaitFor(timeout time.Duration, period time.Duration, f func() (bool, error)) error
• func WaitForWithContext(ctx context.Context, minTimeout, maxTimeout, defaultTimeout time.Duration, ...) error

Functions

func VolumeFromIdSdk

func VolumeFromIdSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, id string) (*api.Volume, error)

VolumeFromIdSdk uses the SDK to fetch the volume object associated with the specified id.

func VolumeFromName

func VolumeFromName(v volume.VolumeDriver, name string) (*api.Volume, error)

VolumeFromName returns the volume object associated with the specified name.

func VolumeFromNameSdk

func VolumeFromNameSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, name string) (*api.Volume, error)

VolumeFromNameSdk uses the SDK to fetch the volume associated with a specified name.

func VolumeIdFromNameSdk

func VolumeIdFromNameSdk(ctx context.Context, volumes api.OpenStorageVolumeClient, name string) (string, error)

VolumeIdFromNameSdk uses the SDK to fetch the volume id associated with the specified name.

func WaitFor

func WaitFor(timeout time.Duration, period time.Duration, f func() (bool, error)) error

WaitFor() waits until f() returns false or err != nil f() returns <wait as bool, or err>.

func WaitForWithContext

func WaitForWithContext(
	ctx context.Context,
	minTimeout, maxTimeout, defaultTimeout time.Duration,
	period time.Duration,
	f func() (bool, error),
) error

WaitForWithContext waits for a function to complete work with a default timeout or a deadline from the context if provided