summaryrefslogtreecommitdiff
path: root/internal/clients/connectors/connector.go
blob: a803c3364f1045671d1ed6fb3eed87182aafcc4b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package connectors

import (
	"context"
	"time"

	"github.com/mimecast/dtail/internal/clients/handlers"
)

// Connector interface.
type Connector interface {
	// Start the connection.
	Start(ctx context.Context, cancel context.CancelFunc, throttleCh, statsCh chan struct{})
	// Server hostname.
	Server() string
	// Handler for the connection.
	Handler() handlers.Handler
	// SupportsQueryUpdates reports whether the connected server advertised
	// runtime query replacement support within the given timeout.
	SupportsQueryUpdates(timeout time.Duration) bool
}