File: interfaces.go

package info (click to toggle)
receptor 1.5.5-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,772 kB
  • sloc: python: 1,643; makefile: 305; sh: 174
file content (44 lines) | stat: -rw-r--r-- 1,585 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
package controlsvc

import (
	"context"
	"crypto/tls"
	"io"
	"net"
	"time"

	"github.com/ansible/receptor/pkg/logger"
	"github.com/ansible/receptor/pkg/netceptor"
)

// ControlCommandType is a type of command that can be run from the control service.
type ControlCommandType interface {
	InitFromString(string) (ControlCommand, error)
	InitFromJSON(map[string]interface{}) (ControlCommand, error)
}

type NetceptorForControlCommand interface {
	GetClientTLSConfig(name string, expectedHostName string, expectedHostNameType netceptor.ExpectedHostnameType) (*tls.Config, error)
	Dial(node string, service string, tlscfg *tls.Config) (*netceptor.Conn, error)
	Ping(ctx context.Context, target string, hopsToLive byte) (time.Duration, string, error)
	MaxForwardingHops() byte
	Status() netceptor.Status
	Traceroute(ctx context.Context, target string) <-chan *netceptor.TracerouteResult
	NodeID() string
	GetLogger() *logger.ReceptorLogger
	CancelBackends()
}

// ControlCommand is an instance of a command that is being run from the control service.
type ControlCommand interface {
	ControlFunc(context.Context, NetceptorForControlCommand, ControlFuncOperations) (map[string]interface{}, error)
}

// ControlFuncOperations provides callbacks for control services to take actions.
type ControlFuncOperations interface {
	BridgeConn(message string, bc io.ReadWriteCloser, bcName string, logger *logger.ReceptorLogger, utils Utiler) error
	ReadFromConn(message string, out io.Writer, io Copier) error
	WriteToConn(message string, in chan []byte) error
	Close() error
	RemoteAddr() net.Addr
}