Documentation
¶
Index ¶
- type CreateEndpointRequest
- type CreateNetworkRequest
- type DeleteEndpointRequest
- type DeleteNetworkRequest
- type Driver
- type EndpointInterface
- type ErrorResponse
- type Handler
- type IPAMData
- type InfoRequest
- type InfoResponse
- type InterfaceName
- type JoinRequest
- type JoinResponse
- type LeaveRequest
- type StaticRoute
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreateEndpointRequest ¶
type CreateEndpointRequest struct { NetworkID string EndpointID string Interface *EndpointInterface Options map[string]interface{} }
CreateEndpointRequest is sent by the daemon when an endpoint should be created
type CreateNetworkRequest ¶
type CreateNetworkRequest struct { NetworkID string Options map[string]interface{} IPv4Data []*IPAMData IPv6Data []*IPAMData }
CreateNetworkRequest is sent by the daemon when a network needs to be created
type DeleteEndpointRequest ¶
DeleteEndpointRequest is sent by the daemon when an endpoint needs to be removed
type DeleteNetworkRequest ¶
type DeleteNetworkRequest struct {
NetworkID string
}
DeleteNetworkRequest is sent by the daemon when a network needs to be removed
type Driver ¶
type Driver interface { CreateNetwork(*CreateNetworkRequest) error DeleteNetwork(*DeleteNetworkRequest) error CreateEndpoint(*CreateEndpointRequest) error DeleteEndpoint(*DeleteEndpointRequest) error EndpointInfo(*InfoRequest) (*InfoResponse, error) Join(*JoinRequest) (*JoinResponse, error) Leave(*LeaveRequest) error }
Driver represent the interface a driver must fulfill.
type EndpointInterface ¶
EndpointInterface contains endpoint interface information
type ErrorResponse ¶
type ErrorResponse struct {
Err string
}
ErrorResponse is a formatted error message that libnetwork can understand
func NewErrorResponse ¶
func NewErrorResponse(msg string) *ErrorResponse
NewErrorResponse creates an ErrorResponse with the provided message
type Handler ¶
Handler forwards requests and responses between the docker daemon and the plugin.
func NewHandler ¶
NewHandler initializes the request handler with a driver implementation.
type IPAMData ¶
type IPAMData struct { AddressSpace string Pool string Gateway string AuxAddresses map[string]interface{} }
IPAMData contains IPv4 or IPv6 addressing information
type InfoRequest ¶
InfoRequest is send by the daemon when querying endpoint information
type InfoResponse ¶
InfoResponse is endpoint information sent in response to an InfoRequest
type InterfaceName ¶
InterfaceName consists of the name of the interface in the global netns and the desired prefix to be appended to the interface inside the container netns
type JoinRequest ¶
type JoinRequest struct { NetworkID string EndpointID string SandboxKey string Options map[string]interface{} }
JoinRequest is sent by the Daemon when an endpoint needs be joined to a network
type JoinResponse ¶
type JoinResponse struct { Gateway string InterfaceName InterfaceName StaticRoutes []*StaticRoute }
JoinResponse is sent in response to a JoinRequest
type LeaveRequest ¶
LeaveRequest is send by the daemon when a endpoint is leaving a network
type StaticRoute ¶
StaticRoute contains static route information