hcsshim

Jul 20, 2023

Changes in this version

+ var ErrOperationDenied = hcs.ErrOperationDenied — windows/amd64

+ func ConvertToBaseLayer(path string) error — windows/amd64

Aug 26, 2021

Changes in this version

+ type HNSEndpointStats = hns.EndpointStats

+ func GetHNSEndpointStats(endpointName string) (*HNSEndpointStats, error)

Mar 2, 2021

Changes in this version

+ func IsAccessIsDenied(err error) bool

+ func IsOperationInvalidState(err error) bool

Apr 10, 2020

Changes in this version

+ const Proxy

+ type ProxyPolicy = hns.ProxyPolicy

Sep 26, 2018

Changes in this version

+ type Namespace = hns.Namespace

Aug 24, 2018

Changes in this version

+ var HNSVersion1803 = hns.HNSVersion1803

+ func CreateScratchLayer(info DriverInfo, layerId, parentId string, parentLayerPaths []string) error

+ func ExpandScratchSize(info DriverInfo, layerId string, size uint64) error

type ContainerError

+ Events []hcs.ErrorEvent

+ type HNSAclFeatures = hns.HNSAclFeatures

+ type HNSGlobals = hns.HNSGlobals

+ func GetHNSGlobals() (*HNSGlobals, error)

+ type HNSSupportedFeatures = hns.HNSSupportedFeatures

+ func GetHNSSupportedFeatures() HNSSupportedFeatures

+ type HNSVersion = hns.HNSVersion

type ProcessError

+ Events []hcs.ErrorEvent

Jul 23, 2018

Changes in this version

type ContainerConfig

+ RegistryChanges *RegistryChanges

+ type RegistryChanges struct

+ AddValues []RegistryValue

+ DeleteKeys []RegistryValue

+ type RegistryKey struct

+ Hive string

+ Name string

+ Volatile bool

+ type RegistryValue struct

+ BinaryValue []byte

+ CustomType *uint32

+ DWordValue *uint32

+ Key RegistryKey

+ Name string

+ QWordValue *uint64

+ StringValue string

+ Type string

Jul 23, 2018

Changes in this version

+ type AssignedDevice struct

+ InterfaceClassGUID string

type ContainerConfig

+ AssignedDevices []AssignedDevice

type MappedDir

+ LinuxMetadata bool

Nov 21, 2017

Changes in this version

type ACLPolicy

+ LocalAddresses string

+ RemoteAddresses string

+ type EndpointNotFoundError struct

+ EndpointName string

+ func (e EndpointNotFoundError) Error() string

+ type NetworkNotFoundError struct

+ NetworkName string

+ func (e NetworkNotFoundError) Error() string

Sep 7, 2017

Changes in this version

type MappedDir

+ CreateInUtilityVM bool

Aug 3, 2017

Changes in this version

+ type EndpointAttachDetachRequest struct

+ CompartmentID uint16

+ ContainerID string

+ SystemType SystemType

+ VirtualNICName string

+ type EndpointResquestResponse struct

+ Error string

+ Success bool

type HNSEndpoint

+ func (endpoint *HNSEndpoint) ContainerAttach(containerID string, compartmentID uint16) error

+ func (endpoint *HNSEndpoint) ContainerDetach(containerID string) error

+ func (endpoint *HNSEndpoint) ContainerHotAttach(containerID string) error

+ func (endpoint *HNSEndpoint) ContainerHotDetach(containerID string) error

+ func (endpoint *HNSEndpoint) HostAttach(compartmentID uint16) error

+ func (endpoint *HNSEndpoint) HostDetach() error

+ func (endpoint *HNSEndpoint) VirtualMachineNICAttach(virtualMachineNICName string) error

+ func (endpoint *HNSEndpoint) VirtualMachineNICDetach() error

type HvRuntime

+ BootSource string

+ WritableBootSource bool

type PolicyList

+ ID string

+ func GetPolicyListByID(policyListID string) (*PolicyList, error)

+ type SystemType string

+ const ContainerType

+ const HostType

+ const VirtualMachineType

Jul 18, 2017

Changes in this version

type Container

+ MappedVirtualDisks func() (map[int]MappedVirtualDiskController, error)

type ContainerProperties

+ MappedVirtualDiskControllers map[int]MappedVirtualDiskController

type HvRuntime

+ LinuxBootParameters string

type MappedVirtualDisk

+ AttachOnly bool

+ type MappedVirtualDiskController struct

+ MappedVirtualDisks map[int]MappedVirtualDisk

Jul 7, 2017

Changes in this version

+ const Allow

+ const Block

+ const Host

+ const In

+ const Out

+ const Switch

+ type ACLPolicy struct

+ Action ActionType

+ Direction DirectionType

+ InternalPort uint16

+ LocalAddress string

+ LocalPort uint16

+ Priority uint16

+ Protocol uint16

+ RemoteAddress string

+ RemotePort uint16

+ RuleType RuleType

+ ServiceName string

+ Type PolicyType

+ type ActionType string

+ type DirectionType string

+ type ELBPolicy struct

+ ILB bool

+ SourceVIP string

+ VIPs []string

type HNSEndpoint

+ func (endpoint *HNSEndpoint) ApplyACLPolicy(policy *ACLPolicy) error

+ func (endpoint *HNSEndpoint) HotAttach(containerID string) error

+ func (endpoint *HNSEndpoint) HotDetach(containerID string) error

+ func (endpoint *HNSEndpoint) Update() (*HNSEndpoint, error)

type HNSNetwork

+ AutomaticDNS bool

+ func (network *HNSNetwork) Create() (*HNSNetwork, error)

+ func (network *HNSNetwork) CreateEndpoint(endpoint *HNSEndpoint) (*HNSEndpoint, error)

+ func (network *HNSNetwork) CreateRemoteEndpoint(endpoint *HNSEndpoint) (*HNSEndpoint, error)

+ func (network *HNSNetwork) Delete() (*HNSNetwork, error)

+ func (network *HNSNetwork) NewEndpoint(ipAddress net.IP, macAddress net.HardwareAddr) *HNSEndpoint

+ type IsolationPolicy struct

+ InDefaultIsolation bool

+ Type PolicyType

+ VLAN uint

+ VSID uint

+ type LBPolicy struct

+ ExternalPort uint16

+ InternalPort uint16

+ Protocol uint16

+ type OutboundNatPolicy struct

+ Exceptions []string

+ VIP string

+ type Policy struct

+ Type PolicyType

+ type PolicyList struct

+ EndpointReferences []string

+ Id string

+ Policies []string

+ func AddLoadBalancer(endpoints []HNSEndpoint, isILB bool, vip string, protocol uint16, ...) (*PolicyList, error)

+ func AddRoute(endpoints []HNSEndpoint, destinationPrefix string, nextHop string, ...) (*PolicyList, error)

+ func HNSListPolicyListRequest() ([]PolicyList, error)

+ func HNSPolicyListRequest(method, path, request string) (*PolicyList, error)

+ func PolicyListRequest(method, path, request string) (*PolicyList, error)

+ func (policylist *PolicyList) AddEndpoint(endpoint *HNSEndpoint) (*PolicyList, error)

+ func (policylist *PolicyList) Create() (*PolicyList, error)

+ func (policylist *PolicyList) Delete() (*PolicyList, error)

+ func (policylist *PolicyList) RemoveEndpoint(endpoint *HNSEndpoint) (*PolicyList, error)

+ type PolicyType string

+ const ACL

+ const ExternalLoadBalancer

+ const Isolation

+ const L2Driver

+ const Nat

+ const OutboundNat

+ const PA

+ const QOS

+ const Route

+ const VLAN

+ const VNet

+ const VSID

+ type RoutePolicy struct

+ DestinationPrefix string

+ EncapEnabled bool

+ NextHop string

+ type RuleType string

Jun 27, 2017

Changes in this version

type ContainerConfig

+ MappedPipes []MappedPipe

+ type MappedPipe struct

+ ContainerPipeName string

+ HostPath string

Jun 23, 2017

Changes in this version

type ProcessConfig

+ CommandArgs []string

Jun 22, 2017

Changes in this version

type HvRuntime

+ LinuxInitrdFile string

+ LinuxKernelFile string

Jun 7, 2017

Changes in this version

type HvRuntime

+ LinuxInitrdPath string

+ LinuxKernelPath string

Jun 7, 2017

Changes in this version

type ContainerConfig

+ MappedVirtualDisks []MappedVirtualDisk

+ type MappedVirtualDisk struct

+ Cache string

+ ContainerPath string

+ CreateInUtilityVM bool

+ HostPath string

+ ReadOnly bool

Jun 1, 2017

Changes in this version

type ContainerConfig

+ ContainerType string

+ TerminateOnLastHandleClosed bool

type ProcessConfig

+ CreateInUtilityVm bool

+ OCISpecification *json.RawMessage

Apr 6, 2017

Changes in this version

+ const Add

+ const Network

+ const Remove

+ var ErrInvalidData = syscall.Errno(0xd)

+ var ErrNotSupported = syscall.Errno(0x32)

+ var ErrPlatformNotSupported = errors.New("unsupported platform request")

+ var ErrVmcomputeInvalidJSON = syscall.Errno(0xc037010d)

+ var ErrVmcomputeUnknownMessage = syscall.Errno(0xc037010b)

+ func HotAttachEndpoint(containerID string, endpointID string) error

+ func HotDetachEndpoint(containerID string, endpointID string) error

+ func IsNotSupported(err error) bool

type Container

+ Modify func(config *ResourceModificationRequestResponse) error

type HNSEndpoint

+ func GetHNSEndpointByID(endpointID string) (*HNSEndpoint, error)

+ func GetHNSEndpointByName(endpointName string) (*HNSEndpoint, error)

+ func HNSListEndpointRequest() ([]HNSEndpoint, error)

+ func (endpoint *HNSEndpoint) Create() (*HNSEndpoint, error)

+ func (endpoint *HNSEndpoint) Delete() (*HNSEndpoint, error)

type HNSNetwork

+ func GetHNSNetworkByID(networkID string) (*HNSNetwork, error)

+ func GetHNSNetworkByName(networkName string) (*HNSNetwork, error)

+ type RequestType string

+ type ResourceModificationRequestResponse struct

+ Data string

+ Request RequestType

+ Resource ResourceType

+ type ResourceType string

Mar 23, 2017

Changes in this version

type Container

+ func CreateContainerWithJSON(id string, c *ContainerConfig, additionalJSON string) (Container, error)

Feb 15, 2017

Changes in this version

+ var ErrVmcomputeOperationAccessIsDenied = syscall.Errno(0x5)

Jan 26, 2017

Changes in this version

type ContainerConfig

+ NetworkSharedContainerName string

Jan 13, 2017

Changes in this version

type ContainerConfig

+ DNSSearchList string

Nov 8, 2016

Changes in this version

type HNSEndpoint

+ DisableICC bool

Nov 8, 2016

Changes in this version

type HNSEndpoint

+ DisableICS bool

Nov 8, 2016

Changes in this version

+ var ErrAlreadyClosed = errors.New("hcsshim: the handle has already been closed")

+ func IsAlreadyClosed(err error) bool

+ type ComputeSystemQuery struct

+ IDs []string

+ Names []string

+ Owners []string

+ Types []string

+ type ContainerProperties struct

+ AreUpdatesPending bool

+ ExitType string

+ ID string

+ IsDummy bool

+ IsRuntimeTemplate bool

+ Name string

+ ObRoot string

+ Owner string

+ ProcessList []ProcessListItem

+ RuntimeID string

+ RuntimeImagePath string

+ SiloGUID string

+ Statistics Statistics

+ Stopped bool

+ SystemType string

+ func GetContainers(q ComputeSystemQuery) ([]ContainerProperties, error)

type ProcessConfig

+ User string

Oct 26, 2016

Changes in this version

type HNSEndpoint

+ IsRemoteEndpoint bool

type HNSNetwork

+ ManagementIP string

+ type PaPolicy struct

+ PA string

+ Type string

Sep 23, 2016

Changes in this version

+ var ErrInvalidHandle = errors.New("hcsshim: the handle is invalid")

type MappedDir

+ BandwidthMaximum uint64

+ IOPSMaximum uint64

Aug 18, 2016

Changes in this version

+ func SetCurrentThreadCompartmentId(compartmentId uint32) (hr error)

type ContainerConfig

+ AllowUnqualifiedDNSQuery bool

type HNSEndpoint

+ EnableInternalDNS bool

type HNSNetwork

+ DNSServerCompartment uint32

type Subnet

+ Policies []json.RawMessage

Aug 18, 2016

Changes in this version

type Container

+ ProcessList func() ([]ProcessListItem, error)

+ type ProcessListItem struct

+ CreateTimestamp time.Time

+ ImageName string

+ KernelTime100ns uint64

+ MemoryCommitBytes uint64

+ MemoryWorkingSetPrivateBytes uint64

+ MemoryWorkingSetSharedBytes uint64

+ ProcessId uint32

+ UserTime100ns uint64

Aug 10, 2016

Changes in this version

+ var ErrComputeSystemDoesNotExist = syscall.Errno(0xc037010e)

+ var ErrElementNotFound = syscall.Errno(0x490)

+ var ErrProcNotFound = syscall.Errno(0x7f)

+ var ErrVmcomputeOperationInvalidState = syscall.Errno(0xc0370105)

+ func IsAlreadyStopped(err error) bool

+ func IsNotExist(err error) bool

+ func IsPending(err error) bool

+ func IsTimeout(err error) bool

type Container

+ Statistics func() (Statistics, error)

+ type MemoryStats struct

+ UsageCommitBytes uint64

+ UsageCommitPeakBytes uint64

+ UsagePrivateWorkingSetBytes uint64

+ type NetworkStats struct

+ BytesReceived uint64

+ BytesSent uint64

+ DroppedPacketsIncoming uint64

+ DroppedPacketsOutgoing uint64

+ EndpointId string

+ InstanceId string

+ PacketsReceived uint64

+ PacketsSent uint64

+ type ProcessorStats struct

+ RuntimeKernel100ns uint64

+ RuntimeUser100ns uint64

+ TotalRuntime100ns uint64

+ type Statistics struct

+ ContainerStartTime time.Time

+ Memory MemoryStats

+ Network []NetworkStats

+ Processor ProcessorStats

+ Storage StorageStats

+ Timestamp time.Time

+ Uptime100ns uint64

+ type StorageStats struct

+ ReadCountNormalized uint64

+ ReadSizeBytes uint64

+ WriteCountNormalized uint64

+ WriteSizeBytes uint64

Jun 24, 2016

Changes in this version

type ContainerConfig

+ ProcessorCount uint32

type HvRuntime

+ SkipTemplate bool

Jun 15, 2016

Changes in this version

+ var ErrUnexpectedValue = errors.New("unexpected value returned from hcs")

+ var ErrVmcomputeAlreadyStopped = syscall.Errno(0xc0370110)

Jun 10, 2016

Changes in this version

+ var ErrHandleClose = errors.New("hcsshim: the handle generating this notification has been closed")

+ var ErrInvalidNotificationType = errors.New("hcsshim: invalid notification type")

type ProcessError

+ ExtraInfo string

Jun 8, 2016

Changes in this version

+ func ExpandSandboxSize(info DriverInfo, layerId string, size uint64) error

type ContainerConfig

+ Credentials string

+ type VlanPolicy struct

+ Type string

+ VLAN uint

+ type VsidPolicy struct

+ Type string

+ VSID uint

May 24, 2016

Changes in this version

+ const ErrVmcomputeOperationPending

+ var ErrInvalidProcessState = errors.New("the process is in an invalid state for the attempted operation")

+ var ErrTimeout = errors.New("hcsshim: timeout waiting for notification")

+ var ErrUnexpectedContainerExit = errors.New("unexpected container exit")

+ var ErrUnexpectedProcessAbort = errors.New("lost communication with compute service")

+ type Container interface

+ Close func() error

+ CreateProcess func(c *ProcessConfig) (Process, error)

+ HasPendingUpdates func() (bool, error)

+ OpenProcess func(pid int) (Process, error)

+ Pause func() error

+ Resume func() error

+ Shutdown func() error

+ Start func() error

+ Terminate func() error

+ Wait func() error

+ WaitTimeout func(time.Duration) error

+ func CreateContainer(id string, c *ContainerConfig) (Container, error)

+ func OpenContainer(id string) (Container, error)

+ type ContainerConfig struct

+ EndpointList []string

+ HostName string

+ HvPartition bool

+ HvRuntime *HvRuntime

+ IgnoreFlushesDuringBoot bool

+ IsDummy bool

+ LayerFolderPath string

+ Layers []Layer

+ MappedDirectories []MappedDir

+ MemoryMaximumInMB int64

+ Name string

+ Owner string

+ ProcessorMaximum int64

+ ProcessorWeight uint64

+ SandboxPath string

+ Servicing bool

+ StorageBandwidthMaximum uint64

+ StorageIOPSMaximum uint64

+ StorageSandboxSize uint64

+ SystemType string

+ VolumePath string

+ type ContainerError struct

+ Container *container

+ Err error

+ ExtraInfo string

+ Operation string

+ func (e *ContainerError) Error() string

+ type HvRuntime struct

+ ImagePath string

+ type Layer struct

+ ID string

+ Path string

+ type MappedDir struct

+ ContainerPath string

+ HostPath string

+ ReadOnly bool

+ type Process interface

+ Close func() error

+ CloseStdin func() error

+ ExitCode func() (int, error)

+ Kill func() error

+ Pid func() int

+ ResizeConsole func(width, height uint16) error

+ Stdio func() (io.WriteCloser, io.ReadCloser, io.ReadCloser, error)

+ Wait func() error

+ WaitTimeout func(time.Duration) error

+ type ProcessConfig struct

+ ApplicationName string

+ CommandLine string

+ ConsoleSize [2]int

+ CreateStdErrPipe bool

+ CreateStdInPipe bool

+ CreateStdOutPipe bool

+ EmulateConsole bool

+ Environment map[string]string

+ WorkingDirectory string

+ type ProcessError struct

+ Err error

+ Operation string

+ Process *process

+ func (e *ProcessError) Error() string

Apr 13, 2016

Changes in this version

+ type ComputeSystemProperties struct

+ AreUpdatesPending bool

+ ID string

+ Name string

+ Stopped bool

+ func GetComputeSystemProperties(id string, flags uint32) (ComputeSystemProperties, error)

Apr 5, 2016

Changes in this version

type FilterLayerWriter

+ func (w *FilterLayerWriter) AddLink(name string, target string) error

type LayerWriter

+ AddLink func(name string, target string) error

Mar 17, 2016

Changes in this version

+ const ERROR_GEN_FAILURE

+ const ERROR_SHUTDOWN_IN_PROGRESS

+ const TimeoutInfinite

+ const WSAEINVAL

+ const WaitErrExecFailed

+ func ActivateLayer(info DriverInfo, id string) error

+ func CreateComputeSystem(id string, configuration string) error

+ func CreateLayer(info DriverInfo, id, parent string) error

+ func CreateProcessInComputeSystem(id string, useStdin bool, useStdout bool, useStderr bool, ...) (_ uint32, _ io.WriteCloser, _ io.ReadCloser, _ io.ReadCloser, err error)

+ func CreateSandboxLayer(info DriverInfo, layerId, parentId string, parentLayerPaths []string) error

+ func DeactivateLayer(info DriverInfo, id string) error

+ func DestroyLayer(info DriverInfo, id string) error

+ func ExportLayer(info DriverInfo, layerId string, exportFolderPath string, ...) error

+ func GetLayerMountPath(info DriverInfo, id string) (string, error)

+ func GetSharedBaseImages() (imageData string, err error)

+ func ImportLayer(info DriverInfo, layerId string, importFolderPath string, ...) error

+ func IsTP4() bool

+ func LayerExists(info DriverInfo, id string) (bool, error)

+ func PrepareLayer(info DriverInfo, layerId string, parentLayerPaths []string) error

+ func ProcessBaseLayer(path string) error

+ func ProcessUtilityVMImage(path string) error

+ func ResizeConsoleInComputeSystem(id string, processid uint32, h, w int) error

+ func ShutdownComputeSystem(id string, timeout uint32, context string) error

+ func StartComputeSystem(id string) error

+ func TerminateComputeSystem(id string, timeout uint32, context string) error

+ func TerminateProcessInComputeSystem(id string, processid uint32) (err error)

+ func UnprepareLayer(info DriverInfo, layerId string) error

+ func WaitForProcessInComputeSystem(id string, processid uint32, timeout uint32) (int32, error)

+ type CreateProcessParams struct

+ ApplicationName string

+ CommandLine string

+ ConsoleSize [2]int

+ EmulateConsole bool

+ Environment map[string]string

+ WorkingDirectory string

+ type DriverInfo struct

+ Flavour int

+ HomeDir string

+ type FilterLayerReader struct

+ func (r *FilterLayerReader) Close() (err error)

+ func (r *FilterLayerReader) Next() (string, int64, *winio.FileBasicInfo, error)

+ func (r *FilterLayerReader) Read(b []byte) (int, error)

+ type FilterLayerWriter struct

+ func (w *FilterLayerWriter) Add(name string, fileInfo *winio.FileBasicInfo) error

+ func (w *FilterLayerWriter) Close() (err error)

+ func (w *FilterLayerWriter) Remove(name string) error

+ func (w *FilterLayerWriter) Write(b []byte) (int, error)

+ type GUID [16]byte

+ func NameToGuid(name string) (id GUID, err error)

+ func NewGUID(source string) *GUID

+ func (g *GUID) ToString() string

+ type HNSEndpoint struct

+ DNSServerList string

+ DNSSuffix string

+ GatewayAddress string

+ IPAddress net.IP

+ Id string

+ MacAddress string

+ Name string

+ Policies []json.RawMessage

+ PrefixLength uint8

+ VirtualNetwork string

+ VirtualNetworkName string

+ func HNSEndpointRequest(method, path, request string) (*HNSEndpoint, error)

+ type HNSNetwork struct

+ DNSServerList string

+ DNSSuffix string

+ Id string

+ MacPools []MacPool

+ Name string

+ NetworkAdapterName string

+ Policies []json.RawMessage

+ SourceMac string

+ Subnets []Subnet

+ Type string

+ func HNSListNetworkRequest(method, path, request string) ([]HNSNetwork, error)

+ func HNSNetworkRequest(method, path, request string) (*HNSNetwork, error)

+ type HcsError struct

+ Err error

+ func (e *HcsError) Error() string

+ type LayerReader interface

+ Close func() error

+ Next func() (string, int64, *winio.FileBasicInfo, error)

+ Read func(b []byte) (int, error)

+ func NewLayerReader(info DriverInfo, layerId string, parentLayerPaths []string) (LayerReader, error)

+ type LayerWriter interface

+ Add func(name string, fileInfo *winio.FileBasicInfo) error

+ Close func() error

+ Remove func(name string) error

+ Write func(b []byte) (int, error)

+ func NewLayerWriter(info DriverInfo, layerId string, parentLayerPaths []string) (LayerWriter, error)

+ type LegacyLayerReader struct

+ func NewLegacyLayerReader(root string) *LegacyLayerReader

+ func (r *LegacyLayerReader) Close() error

+ func (r *LegacyLayerReader) Next() (path string, size int64, fileInfo *winio.FileBasicInfo, err error)

+ func (r *LegacyLayerReader) Read(b []byte) (int, error)

+ type LegacyLayerWriter struct

+ func NewLegacyLayerWriter(root string) *LegacyLayerWriter

+ func (w *LegacyLayerWriter) Add(name string, fileInfo *winio.FileBasicInfo) error

+ func (w *LegacyLayerWriter) Close() error

+ func (w *LegacyLayerWriter) Remove(name string) error

+ func (w *LegacyLayerWriter) Write(b []byte) (int, error)

+ type MacPool struct

+ EndMacAddress string

+ StartMacAddress string

+ type NatPolicy struct

+ ExternalPort uint16

+ InternalPort uint16

+ Protocol string

+ Type string

+ type QosPolicy struct

+ MaximumOutgoingBandwidthInBytes uint64

+ Type string

+ type Subnet struct

+ AddressPrefix string

+ GatewayAddress string

+ type WC_LAYER_DESCRIPTOR struct

+ Flags uint32

+ LayerId GUID

+ Pathp *uint16