signallingserver

package

v2.0.1 Latest Latest Go to latest Published: Aug 23, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/forestnode-io/oneshot

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CloseDiscoveryServer(ctx context.Context) error
func ConnectToDiscoveryServer(ctx context.Context, c DiscoveryServerConfig) error
func Receive[M messages.Message](d *DiscoveryServer) (M, error)
func ReconnectDiscoveryServer(ctx context.Context) error
func Send[M messages.Message](d *DiscoveryServer, m M) error
func SendArrivalToDiscoveryServer(ctx context.Context, arrival *messages.ServerArrivalRequest) error
func SendReportToDiscoveryServer(ctx context.Context, report *messages.Report)
func WithDiscoveryServer(ctx context.Context) (context.Context, <-chan struct{})
type DiscoveryServer
- func GetDiscoveryServer(ctx context.Context) *DiscoveryServer
- func (d *DiscoveryServer) Close() error
- func (d *DiscoveryServer) Stream() proto.SignallingServer_ConnectClient
type DiscoveryServerConfig

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrClosedByUser = errors.New("closed by user")

View Source

var ErrHandshakeTimeout = errors.New("handshake timed out")

Functions ¶

func CloseDiscoveryServer ¶

func CloseDiscoveryServer(ctx context.Context) error

func ConnectToDiscoveryServer ¶

func ConnectToDiscoveryServer(ctx context.Context, c DiscoveryServerConfig) error

ConnectToDiscoveryServer connects to the discovery server and sends a handshake. The connnection is kept open and stuffed into the context.

func Receive ¶

func Receive[M messages.Message](d *DiscoveryServer) (M, error)

func ReconnectDiscoveryServer ¶

func ReconnectDiscoveryServer(ctx context.Context) error

func Send ¶

func Send[M messages.Message](d *DiscoveryServer, m M) error

func SendArrivalToDiscoveryServer ¶

func SendArrivalToDiscoveryServer(ctx context.Context, arrival *messages.ServerArrivalRequest) error

func SendReportToDiscoveryServer ¶

func SendReportToDiscoveryServer(ctx context.Context, report *messages.Report)

func WithDiscoveryServer ¶

func WithDiscoveryServer(ctx context.Context) (context.Context, <-chan struct{})

Types ¶

type DiscoveryServer ¶

type DiscoveryServer struct {
	AssignedURL string

	AcceptsReport bool
	// contains filtered or unexported fields
}

func GetDiscoveryServer ¶

func GetDiscoveryServer(ctx context.Context) *DiscoveryServer

func (*DiscoveryServer) Close ¶

func (d *DiscoveryServer) Close() error

func (*DiscoveryServer) Stream ¶

func (d *DiscoveryServer) Stream() proto.SignallingServer_ConnectClient

type DiscoveryServerConfig ¶

type DiscoveryServerConfig struct {
	Enabled                   bool
	URL                       string
	Key                       string
	Insecure                  bool
	TLSCert                   string
	TLSKey                    string
	SendReports               bool
	HeaderBlockList           []string
	HeaderAllowList           []string
	UseDefaultHeaderBlockList bool

	VersionInfo messages.VersionInfo
}

Source Files ¶

View all Source files

discoveryServer.go

Directories ¶

Path	Synopsis
headers
messages
proto

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL