Documentation ¶
Index ¶
- func AddDriver(name string, driverCreate DriverCreateFunc)
- func GetDefaultCableDriver() string
- func RecordConnection(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
- func RecordConnectionLatency(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
- func RecordDisconnected(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec)
- func RecordRxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
- func RecordTxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, ...)
- func SetDefaultCableDriver(driver string)
- type Driver
- type DriverCreateFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddDriver ¶
func AddDriver(name string, driverCreate DriverCreateFunc)
Adds a supported driver, prints a fatal error in the case of double registration.
func GetDefaultCableDriver ¶
func GetDefaultCableDriver() string
Returns the default cable driver name.
func RecordConnection ¶ added in v0.8.0
func RecordConnection(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, status string, isNew bool)
func RecordConnectionLatency ¶ added in v0.8.0
func RecordConnectionLatency(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, latencySeconds float64)
func RecordDisconnected ¶ added in v0.8.0
func RecordDisconnected(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec)
func RecordRxBytes ¶ added in v0.8.0
func RecordRxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, bytes int)
func RecordTxBytes ¶ added in v0.8.0
func RecordTxBytes(cableDriverName string, localEndpoint, remoteEndpoint *submv1.EndpointSpec, bytes int)
func SetDefaultCableDriver ¶ added in v0.3.0
func SetDefaultCableDriver(driver string)
Sets the default cable driver name, if it is not specified by user.
Types ¶
type Driver ¶
type Driver interface { // Init initializes the driver with any state it needs. Init() error // GetActiveConnections returns an array of all the active connections. GetActiveConnections() ([]v1.Connection, error) // GetConnections() returns an array of the existing connections, including status and endpoint info GetConnections() ([]v1.Connection, error) // ConnectToEndpoint establishes a connection to the given endpoint and returns a string // representation of the IP address of the target endpoint. ConnectToEndpoint(endpointInfo *natdiscovery.NATEndpointInfo) (string, error) // DisconnectFromEndpoint disconnects from the connection to the given endpoint. DisconnectFromEndpoint(endpoint *types.SubmarinerEndpoint) error // GetName returns driver's name GetName() string // Cleanup performs the necessary uninstallation. Cleanup() error }
Driver is used by the ipsec engine to actually connect the tunnels.
type DriverCreateFunc ¶
type DriverCreateFunc func(localEndpoint *endpoint.Local, localCluster *types.SubmarinerCluster) (Driver, error)
Function prototype to create a new driver.
Click to show internal directories.
Click to hide internal directories.