Categorygithub.com/stffabi/go-plugins-helpersgraphdriver
package
0.0.0-20170102144606-65a562254f78
Repository: https://github.com/stffabi/go-plugins-helpers.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
6
Dependents
0
Files
565 SLOC

# README

Docker volume extension api.

Go handler to create external graphdriver extensions for Docker.

Usage

This library is designed to be integrated in your program.

  1. Implement the graphdriver.Driver interface.
  2. Initialize a graphdriver.Handler with your implementation.
  3. Call either ServeTCP or ServeUnix from the graphdriver.Handler.

Example using TCP sockets:

  d := MyGraphDriver{}
  h := graphdriver.NewHandler(d)
  h.ServeTCP("test_graph", ":8080")

Example using Unix sockets:

  d := MyGraphDriver{}
  h := graphdriver.NewHandler(d)
  h.ServeUnix("root", "test_graph")

# Packages

No description provided by the author

# Functions

CallApplyDiff is the raw call to the Graphdriver.ApplyDiff method.
CallChanges is the raw call to the Graphdriver.Changes method.
CallCleanup is the raw call to the Graphdriver.Cleanup method.
CallCreate is the raw call to the Graphdriver.Create method.
CallCreateReadWrite is the raw call to the Graphdriver.CreateReadWrite method.
CallDiff is the raw call to the Graphdriver.Diff method.
CallDiffSize is the raw call to the Graphdriver.CallDiffSize method.
CallExists is the raw call to the Graphdriver.Exists method.
CallGet is the raw call to the Graphdriver.Get method.
CallGetMetadata is the raw call to the Graphdriver.GetMetadata method.
CallInit is the raw call to the Graphdriver.Init method.
CallPut is the raw call to the Graphdriver.Put method.
CallRemove is the raw call to the Graphdriver.Remove method.
CallStatus is the raw call to the Graphdriver.Status method.
NewHandler initializes the request handler with a driver implementation.

# Constants

Added is a ChangeKind used when an item has been added.
DefaultDockerRootDirectory is the default directory where graph drivers will be created.
Deleted is a ChangeKind used when an item has been deleted.
Modified is a ChangeKind used when an item has been modified.

# Structs

ApplyDiffRequest is the structure that docker's applyDiff requests are deserialized to.
ApplyDiffResponse is the structure that docker's applyDiff responses are serialized to.
Change is the structure that docker's individual changes are serialized to.
ChangesRequest is the structure that docker's changes requests are deserialized to.
ChangesResponse is the structure that docker's changes responses are serialized to.
CleanupRequest is the structure that docker's cleanup requests are deserialized to.
CleanupResponse is the structure that docker's cleanup responses are serialized to.
CreateRequest is the structure that docker's create requests are deserialized to.
CreateResponse is the strucutre that docker's create responses are serialized to.
DiffRequest is the structure that docker's diff requests are deserialized to.
DiffResponse is the structure that docker's diff responses are serialized to.
DiffSizeRequest is the structure that docker's diffSize requests are deserialized to.
DiffSizeResponse is the structure that docker's diffSize responses are serialized to.
ExistsRequest is the structure that docker's exists requests are deserialized to.
ExistsResponse is the structure that docker's exists responses are serialized to.
GetMetadataRequest is the structure that docker's getMetadata requests are deserialized to.
GetMetadataResponse is the structure that docker's getMetadata responses are serialized to.
GetRequest is the structure that docker's get requests are deserialized to.
GetResponse is the strucutre that docker's remove responses are serialized to.
Handler forwards requests and responses between the docker daemon and the plugin.
InitRequest is the structure that docker's init requests are deserialized to.
InitResponse is the strucutre that docker's init responses are serialized to.
PutRequest is the structure that docker's put requests are deserialized to.
PutResponse is the strucutre that docker's put responses are serialized to.
RemoveRequest is the structure that docker's remove requests are deserialized to.
RemoveResponse is the strucutre that docker's remove responses are serialized to.
StatusRequest is the structure that docker's status requests are deserialized to.
StatusResponse is the structure that docker's status responses are serialized to.

# Interfaces

Driver represent the interface a driver must fulfill.

# Type aliases

ChangeKind represents the type of change mage.