Documentation ¶
Overview ¶
Package vim25 provides a minimal client implementation to use with other packages in the vim25 tree. The code in this package intentionally does not take any dependendies outside the vim25 tree.
The client implementation in this package embeds the soap.Client structure. Additionally, it stores the value of the session's ServiceContent object. This object stores references to a variety of subsystems, such as the root property collector, the session manager, and the search index. The client is fully functional after serialization and deserialization, without the need for additional requests for initialization.
Index ¶
Constants ¶
const ( Namespace = "vim25" Version = "6.7" Path = "/sdk" )
Variables ¶
var (
ServiceInstance = types.ManagedObjectReference{
Type: "ServiceInstance",
Value: "ServiceInstance",
}
)
Functions ¶
func Retry ¶
func Retry(roundTripper soap.RoundTripper, fn RetryFunc) soap.RoundTripper
Retry wraps the specified soap.RoundTripper and invokes the specified RetryFunc. The RetryFunc returns whether or not to retry the call, and if so, how long to wait before retrying. If the result of this function is to not retry, the original error is returned from the RoundTrip function.
Types ¶
type Client ¶
type Client struct { *soap.Client ServiceContent types.ServiceContent // RoundTripper is a separate field such that the client's implementation of // the RoundTripper interface can be wrapped by separate implementations for // extra functionality (for example, reauthentication on session timeout). RoundTripper soap.RoundTripper }
Client is a tiny wrapper around the vim25/soap Client that stores session specific state (i.e. state that only needs to be retrieved once after the client has been created). This means the client can be reused after serialization without performing additional requests for initialization.
func NewClient ¶
NewClient creates and returns a new client with the ServiceContent field filled in.
func (*Client) MarshalJSON ¶
func (*Client) UnmarshalJSON ¶
func (*Client) UseServiceVersion ¶ added in v0.21.0
UseServiceVersion sets soap.Client.Version to the current version of the service endpoint via /sdk/vimServiceVersions.xml
type RetryFunc ¶
func TemporaryNetworkError ¶
TemporaryNetworkError returns a RetryFunc that retries up to a maximum of n times, only if the error returned by the RoundTrip function is a temporary network error (for example: a connect timeout).