Documentation
¶
Index ¶
- Constants
- type Driver
- func (d *Driver) CreateEndpoint(r *network.CreateEndpointRequest) (*network.CreateEndpointResponse, error)
- func (d *Driver) CreateNetwork(r *network.CreateNetworkRequest) error
- func (d *Driver) DeleteEndpoint(r *network.DeleteEndpointRequest) error
- func (d *Driver) DeleteNetwork(r *network.DeleteNetworkRequest) error
- func (d *Driver) EndpointInfo(r *network.InfoRequest) (*network.InfoResponse, error)
- func (d *Driver) GetCapabilities() (*network.CapabilitiesResponse, error)
- func (d *Driver) Join(r *network.JoinRequest) (*network.JoinResponse, error)
- func (d *Driver) Leave(r *network.LeaveRequest) error
- type EndpointNotFoundError
- type ErrInvalidEndpointConfig
- type ErrUnsupportedAddressType
- type InvalidEndpointIDError
- type NetworkState
Constants ¶
const (
// TorChain is the TOR iptable chain name.
TorChain = "TOR"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Driver ¶
Driver represents the interface for the network plugin driver.
func (*Driver) CreateEndpoint ¶
func (d *Driver) CreateEndpoint(r *network.CreateEndpointRequest) (*network.CreateEndpointResponse, error)
CreateEndpoint creates new endpoints for a container.
func (*Driver) CreateNetwork ¶
func (d *Driver) CreateNetwork(r *network.CreateNetworkRequest) error
CreateNetwork creates a new tor network.
func (*Driver) DeleteEndpoint ¶
func (d *Driver) DeleteEndpoint(r *network.DeleteEndpointRequest) error
DeleteEndpoint deletes the given endpoints.
func (*Driver) DeleteNetwork ¶
func (d *Driver) DeleteNetwork(r *network.DeleteNetworkRequest) error
DeleteNetwork deletes a given tor network.
func (*Driver) EndpointInfo ¶
func (d *Driver) EndpointInfo(r *network.InfoRequest) (*network.InfoResponse, error)
EndpointInfo returns information about an endpoint.
func (*Driver) GetCapabilities ¶
func (d *Driver) GetCapabilities() (*network.CapabilitiesResponse, error)
GetCapabilities gets the scope for the network.
func (*Driver) Join ¶
func (d *Driver) Join(r *network.JoinRequest) (*network.JoinResponse, error)
Join creates a veth pair connected to the requested network.
type EndpointNotFoundError ¶
type EndpointNotFoundError string
EndpointNotFoundError is returned when the no endpoint with the passed endpoint id is found.
func (EndpointNotFoundError) Error ¶
func (enfe EndpointNotFoundError) Error() string
func (EndpointNotFoundError) NotFound ¶
func (enfe EndpointNotFoundError) NotFound()
NotFound denotes the type of this error
type ErrInvalidEndpointConfig ¶
type ErrInvalidEndpointConfig struct{}
ErrInvalidEndpointConfig error is returned when a endpoint create is attempted with an invalid endpoint configuration.
func (*ErrInvalidEndpointConfig) BadRequest ¶
func (eiec *ErrInvalidEndpointConfig) BadRequest()
BadRequest denotes the type of this error
func (*ErrInvalidEndpointConfig) Error ¶
func (eiec *ErrInvalidEndpointConfig) Error() string
type ErrUnsupportedAddressType ¶
type ErrUnsupportedAddressType string
ErrUnsupportedAddressType is returned when the specified address type is not supported.
func (ErrUnsupportedAddressType) BadRequest ¶
func (uat ErrUnsupportedAddressType) BadRequest()
BadRequest denotes the type of this error
func (ErrUnsupportedAddressType) Error ¶
func (uat ErrUnsupportedAddressType) Error() string
type InvalidEndpointIDError ¶
type InvalidEndpointIDError string
InvalidEndpointIDError is returned when the passed endpoint id is not valid.
func (InvalidEndpointIDError) BadRequest ¶
func (ieie InvalidEndpointIDError) BadRequest()
BadRequest denotes the type of this error
func (InvalidEndpointIDError) Error ¶
func (ieie InvalidEndpointIDError) Error() string
Source Files