types

Documentation

Overview

Package types contains types that are common across libnetwork project

Index

• Constants
• func BadRequestErrorf(format string, params ...interface{}) error
• func CompareIPNet(a, b *net.IPNet) bool
• func ForbiddenErrorf(format string, params ...interface{}) error
• func GetBroadcastIP(ip net.IP, mask net.IPMask) (net.IP, error)
• func GetHostPartIP(ip net.IP, mask net.IPMask) (net.IP, error)
• func GetIPCopy(from net.IP) net.IP
• func GetIPNetCanonical(nw *net.IPNet) *net.IPNet
• func GetIPNetCopy(from *net.IPNet) *net.IPNet
• func GetMacCopy(from net.HardwareAddr) net.HardwareAddr
• func GetMinimalIP(ip net.IP) net.IP
• func GetMinimalIPNet(nw *net.IPNet) *net.IPNet
• func InternalErrorf(format string, params ...interface{}) error
• func InternalMaskableErrorf(format string, params ...interface{}) error
• func IsIPNetValid(nw *net.IPNet) bool
• func NoServiceErrorf(format string, params ...interface{}) error
• func NotFoundErrorf(format string, params ...interface{}) error
• func NotImplementedErrorf(format string, params ...interface{}) error
• func ParseCIDR(cidr string) (n *net.IPNet, e error)
• func RetryErrorf(format string, params ...interface{}) error
• func TimeoutErrorf(format string, params ...interface{}) error
• type BadRequestError
• type ErrInvalidProtocolBinding
  • func (ipb ErrInvalidProtocolBinding) Error() string
• type ForbiddenError
• type InterfaceStatistics
  • func (is *InterfaceStatistics) String() string
• type InternalError
• type MaskableError
• type NoServiceError
• type NotFoundError
• type NotImplementedError
• type PortBinding
  • func (p PortBinding) ContainerAddr() (net.Addr, error)
  • func (p *PortBinding) Equal(o *PortBinding) bool
  • func (p *PortBinding) FromString(s string) error
  • func (p *PortBinding) GetCopy() PortBinding
  • func (p PortBinding) HostAddr() (net.Addr, error)
  • func (p *PortBinding) String() string
• type Protocol
  • func ParseProtocol(s string) Protocol
  • func (p Protocol) String() string
• type QosPolicy
• type RetryError
• type StaticRoute
  • func (r *StaticRoute) GetCopy() *StaticRoute
• type TimeoutError
• type TransportPort
  • func (t *TransportPort) Equal(o *TransportPort) bool
  • func (t *TransportPort) FromString(s string) error
  • func (t *TransportPort) GetCopy() TransportPort
  • func (t *TransportPort) String() string
• type UUID

Constants

const (
	IP = iota // IPv4 and IPv6
	IPv4
	IPv6
)

constants for the IP address type

const (
	// ICMP is for the ICMP ip protocol
	ICMP = 1
	// TCP is for the TCP ip protocol
	TCP = 6
	// UDP is for the UDP ip protocol
	UDP = 17
)

const (
	// NEXTHOP indicates a StaticRoute with an IP next hop.
	NEXTHOP = iota

	// CONNECTED indicates a StaticRoute with an interface for directly connected peers.
	CONNECTED
)

Functions

func BadRequestErrorf

func BadRequestErrorf(format string, params ...interface{}) error

BadRequestErrorf creates an instance of BadRequestError

func CompareIPNet

func CompareIPNet(a, b *net.IPNet) bool

CompareIPNet returns equal if the two IP Networks are equal

func ForbiddenErrorf

func ForbiddenErrorf(format string, params ...interface{}) error

ForbiddenErrorf creates an instance of ForbiddenError

func GetBroadcastIP

func GetBroadcastIP(ip net.IP, mask net.IPMask) (net.IP, error)

GetBroadcastIP returns the broadcast ip address for the passed network (ip and mask). IP address representation is not modified. If address and mask are not compatible an error is returned.

func GetHostPartIP

func GetHostPartIP(ip net.IP, mask net.IPMask) (net.IP, error)

GetHostPartIP returns the host portion of the ip address identified by the mask. IP address representation is not modified. If address and mask are not compatible an error is returned.

func GetIPCopy

func GetIPCopy(from net.IP) net.IP

GetIPCopy returns a copy of the passed IP address

func GetIPNetCanonical

func GetIPNetCanonical(nw *net.IPNet) *net.IPNet

GetIPNetCanonical returns the canonical form for the passed network

func GetIPNetCopy

func GetIPNetCopy(from *net.IPNet) *net.IPNet

GetIPNetCopy returns a copy of the passed IP Network

func GetMacCopy

func GetMacCopy(from net.HardwareAddr) net.HardwareAddr

GetMacCopy returns a copy of the passed MAC address

func GetMinimalIP

func GetMinimalIP(ip net.IP) net.IP

GetMinimalIP returns the address in its shortest form

func GetMinimalIPNet

func GetMinimalIPNet(nw *net.IPNet) *net.IPNet

GetMinimalIPNet returns a copy of the passed IP Network with congruent ip and mask notation

func InternalErrorf

func InternalErrorf(format string, params ...interface{}) error

InternalErrorf creates an instance of InternalError

func InternalMaskableErrorf

func InternalMaskableErrorf(format string, params ...interface{}) error

InternalMaskableErrorf creates an instance of InternalError and MaskableError

func IsIPNetValid

func IsIPNetValid(nw *net.IPNet) bool

IsIPNetValid returns true if the ipnet is a valid network/mask combination. Otherwise returns false.

func NoServiceErrorf

func NoServiceErrorf(format string, params ...interface{}) error

NoServiceErrorf creates an instance of NoServiceError

func NotFoundErrorf

func NotFoundErrorf(format string, params ...interface{}) error

NotFoundErrorf creates an instance of NotFoundError

func NotImplementedErrorf

func NotImplementedErrorf(format string, params ...interface{}) error

NotImplementedErrorf creates an instance of NotImplementedError

func ParseCIDR

func ParseCIDR(cidr string) (n *net.IPNet, e error)

ParseCIDR returns the *net.IPNet represented by the passed CIDR notation

func RetryErrorf

func RetryErrorf(format string, params ...interface{}) error

RetryErrorf creates an instance of RetryError

func TimeoutErrorf

func TimeoutErrorf(format string, params ...interface{}) error

TimeoutErrorf creates an instance of TimeoutError

Types

type BadRequestError

type BadRequestError interface {
	// BadRequest makes implementer into BadRequestError type
	BadRequest()
}

BadRequestError is an interface for errors originated by a bad request

type ErrInvalidProtocolBinding

type ErrInvalidProtocolBinding string

ErrInvalidProtocolBinding is returned when the port binding protocol is not valid.

func (ErrInvalidProtocolBinding) Error

func (ipb ErrInvalidProtocolBinding) Error() string

type ForbiddenError

type ForbiddenError interface {
	// Forbidden makes implementer into ForbiddenError type
	Forbidden()
}

ForbiddenError is an interface for errors which denote a valid request that cannot be honored

type InterfaceStatistics

type InterfaceStatistics struct {
	RxBytes   uint64
	RxPackets uint64
	RxErrors  uint64
	RxDropped uint64
	TxBytes   uint64
	TxPackets uint64
	TxErrors  uint64
	TxDropped uint64
}

InterfaceStatistics represents the interface's statistics

func (*InterfaceStatistics) String

func (is *InterfaceStatistics) String() string

type InternalError

type InternalError interface {
	// Internal makes implementer into InternalError type
	Internal()
}

InternalError is an interface for errors raised because of an internal error

type MaskableError

type MaskableError interface {
	// Maskable makes implementer into MaskableError type
	Maskable()
}

MaskableError is an interface for errors which can be ignored by caller

type NoServiceError

type NoServiceError interface {
	// NoService makes implementer into NoServiceError type
	NoService()
}

NoServiceError is an interface for errors returned when the required service is not available

type NotFoundError

type NotFoundError interface {
	// NotFound makes implementer into NotFoundError type
	NotFound()
}

NotFoundError is an interface for errors raised because a needed resource is not available

type NotImplementedError

type NotImplementedError interface {
	// NotImplemented makes implementer into NotImplementedError type
	NotImplemented()
}

NotImplementedError is an interface for errors raised because of requested functionality is not yet implemented

type PortBinding

type PortBinding struct {
	Proto       Protocol
	IP          net.IP
	Port        uint16
	HostIP      net.IP
	HostPort    uint16
	HostPortEnd uint16
}

PortBinding represent a port binding between the container and the host

func (PortBinding) ContainerAddr

func (p PortBinding) ContainerAddr() (net.Addr, error)

ContainerAddr returns the container side transport address

func (*PortBinding) Equal

func (p *PortBinding) Equal(o *PortBinding) bool

Equal checks if this instance of PortBinding is equal to the passed one

func (*PortBinding) FromString

func (p *PortBinding) FromString(s string) error

FromString reads the TransportPort structure from string

func (*PortBinding) GetCopy

func (p *PortBinding) GetCopy() PortBinding

GetCopy returns a copy of this PortBinding structure instance

func (PortBinding) HostAddr

func (p PortBinding) HostAddr() (net.Addr, error)

HostAddr returns the host side transport address

func (*PortBinding) String

func (p *PortBinding) String() string

String return the PortBinding structure in string form

type Protocol

type Protocol uint8

Protocol represents a IP protocol number

func ParseProtocol

func ParseProtocol(s string) Protocol

ParseProtocol returns the respective Protocol type for the passed string

func (Protocol) String

func (p Protocol) String() string

type QosPolicy

type QosPolicy struct {
	MaxEgressBandwidth uint64
}

QosPolicy represents a quality of service policy on an endpoint

type RetryError

type RetryError interface {
	// Retry makes implementer into RetryError type
	Retry()
}

RetryError is an interface for errors which might get resolved through retry

type StaticRoute

type StaticRoute struct {
	Destination *net.IPNet

	RouteType int // NEXT_HOP or CONNECTED

	// NextHop will be resolved by the kernel (i.e. as a loose hop).
	NextHop net.IP
}

StaticRoute is a statically-provisioned IP route.

func (*StaticRoute) GetCopy

func (r *StaticRoute) GetCopy() *StaticRoute

GetCopy returns a copy of this StaticRoute structure

type TimeoutError

type TimeoutError interface {
	// Timeout makes implementer into TimeoutError type
	Timeout()
}

TimeoutError is an interface for errors raised because of timeout

type TransportPort

type TransportPort struct {
	Proto Protocol
	Port  uint16
}

TransportPort represent a local Layer 4 endpoint

func (*TransportPort) Equal

func (t *TransportPort) Equal(o *TransportPort) bool

Equal checks if this instance of Transportport is equal to the passed one

func (*TransportPort) FromString

func (t *TransportPort) FromString(s string) error

FromString reads the TransportPort structure from string

func (*TransportPort) GetCopy

func (t *TransportPort) GetCopy() TransportPort

GetCopy returns a copy of this TransportPort structure instance

func (*TransportPort) String

func (t *TransportPort) String() string

String returns the TransportPort structure in string form

type UUID

type UUID string

UUID represents a globally unique ID of various resources like network and endpoint