network

type AllocateNetworkRequest struct {
	// A network ID that remote plugins are expected to store for future
	// reference.
	NetworkID string

	// A free form map->object interface for communication of options.
	Options map[string]string

	// IPAMData contains the address pool information for this network
	IPv4Data, IPv6Data []IPAMData
}

type AllocateNetworkResponse struct {
	// A free form plugin specific string->string object to be sent in
	// CreateNetworkRequest call in the libnetwork agents
	Options map[string]string
}

type CapabilitiesResponse struct {
	Scope             CapabilitiesResponseScope
	ConnectivityScope CapabilitiesResponseScope
	GwAllocChecker    bool
}

type CapabilitiesResponseScope string

type CreateEndpointRequest struct {
	NetworkID  string
	EndpointID string
	Interface  *EndpointInterface
	Options    map[string]interface{}
}

type CreateEndpointResponse struct {
	Interface *EndpointInterface
}

type CreateNetworkRequest struct {
	NetworkID string
	Options   CreateNetworkRequestOptions
	IPv4Data  []*IPAMData
	IPv6Data  []*IPAMData
}

type CreateNetworkRequestOptions struct {
	Generic    map[string]string `json:"com.docker.network.generic"`
	EnableIPv4 bool              `json:"com.docker.network.enable_ipv4"`
	EnableIPv6 bool              `json:"com.docker.network.enable_ipv6"`
}

type DeleteEndpointRequest struct {
	NetworkID  string
	EndpointID string
}

type DeleteNetworkRequest struct {
	NetworkID string
}

type DiscoveryNotification struct {
	DiscoveryType int
	DiscoveryData interface{}
}

type Driver interface {
	// GetCapabilities returns the driver capabilities
	// https://github.com/moby/moby/blob/master/libnetwork/docs/remote.md#set-capability
	GetCapabilities(context.Context) (*CapabilitiesResponse, error)
	CreateNetwork(context.Context, *CreateNetworkRequest) error
	AllocateNetwork(context.Context, *AllocateNetworkRequest) (*AllocateNetworkResponse, error)
	DeleteNetwork(context.Context, *DeleteNetworkRequest) error
	FreeNetwork(context.Context, *FreeNetworkRequest) error
	CreateEndpoint(context.Context, *CreateEndpointRequest) (*CreateEndpointResponse, error)
	DeleteEndpoint(context.Context, *DeleteEndpointRequest) error
	EndpointInfo(context.Context, *InfoRequest) (*InfoResponse, error)
	Join(context.Context, *JoinRequest) (*JoinResponse, error)
	Leave(context.Context, *LeaveRequest) error
	DiscoverNew(context.Context, *DiscoveryNotification) error
	DiscoverDelete(context.Context, *DiscoveryNotification) error
	ProgramExternalConnectivity(context.Context, *ProgramExternalConnectivityRequest) error
	RevokeExternalConnectivity(context.Context, *RevokeExternalConnectivityRequest) error
}

type EndpointInterface struct {
	Address     string
	AddressIPv6 string
	MacAddress  string
}

type FreeNetworkRequest struct {
	// The ID of the network to be freed.
	NetworkID string
}

type Handler struct {
	sdk.Handler
	// contains filtered or unexported fields
}

type IPAMData struct {
	AddressSpace string
	Pool         string
	Gateway      string
	AuxAddresses map[string]interface{}
}

type InfoRequest struct {
	NetworkID  string
	EndpointID string
}

type InfoResponse struct {
	Value map[string]string
}

type InterfaceName struct {
	SrcName   string
	DstPrefix string
}

type JoinRequest struct {
	NetworkID  string
	EndpointID string
	SandboxKey string
	Options    map[string]interface{}
}

type JoinResponse struct {
	InterfaceName         InterfaceName
	Gateway               string
	GatewayIPv6           string
	StaticRoutes          []*StaticRoute
	DisableGatewayService bool
}

type LeaveRequest struct {
	NetworkID  string
	EndpointID string
}

type ProgramExternalConnectivityRequest struct {
	NetworkID  string
	EndpointID string
	Options    map[string]interface{}
}

type RevokeExternalConnectivityRequest struct {
	NetworkID  string
	EndpointID string
}

type StaticRoute struct {
	Destination string
	RouteType   int
	NextHop     string
}