network

Documentation

Index

• func NewRouter(b Backend, c ClusterBackend) router.Router
• type Backend
• type ClusterBackend

Functions

func NewRouter

func NewRouter(b Backend, c ClusterBackend) router.Router

NewRouter initializes a new network router

Types

type Backend

type Backend interface {
	GetNetworks(filters.Args, types.NetworkListConfig) ([]types.NetworkResource, error)
	CreateNetwork(nc types.NetworkCreateRequest) (*types.NetworkCreateResponse, error)
	ConnectContainerToNetwork(containerName, networkName string, endpointConfig *network.EndpointSettings) error
	DisconnectContainerFromNetwork(containerName string, networkName string, force bool) error
	DeleteNetwork(networkID string) error
	NetworksPrune(ctx context.Context, pruneFilters filters.Args) (*types.NetworksPruneReport, error)
}

Backend is all the methods that need to be implemented to provide network specific functionality.

type ClusterBackend

type ClusterBackend interface {
	GetNetworks(filters.Args) ([]types.NetworkResource, error)
	GetNetwork(name string) (types.NetworkResource, error)
	GetNetworksByName(name string) ([]types.NetworkResource, error)
	CreateNetwork(nc types.NetworkCreateRequest) (string, error)
	RemoveNetwork(name string) error
}

ClusterBackend is all the methods that need to be implemented to provide cluster network specific functionality.