remoteaccess

package

v0.0.0-...-9d0ed1b Latest Latest Go to latest Published: May 3, 2024 License: Apache-2.0 Imports: 20 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

This section is empty.

This section is empty.

This section is empty.

type Console struct {
	// contains filtered or unexported fields
}

Console contains resources involved in a remote console session.

func NewConsole(ctx context.Context, rows, cols uint16) (*Console, error)

NewConsole creates a new console. It returns a Console object and an error if any. If err == nil, the caller is responsible for closing the Console.

func (c *Console) Close()

Close the console and release all resources.

func (c *Console) Resize(rows, cols uint16) error

Resize the console.

type Service struct {
	// contains filtered or unexported fields
}

Service controls remote access for the agent.

func New() *Service

New creates a new instance of the remote access service.

func (s *Service) HandleConsole(ctx context.Context, stream *smux.Stream, payload []byte) error

HandleConsole handles a remote console stream.

func (s *Service) HandleConsoleCommand(_ context.Context, stream *smux.Stream, payload []byte) error

HandleConsoleCommand handles a remote console command. This is primary used to resize an existing console.

func (s *Service) HandleReloadCommand(_ context.Context, stream *smux.Stream, _ []byte) error

HandleReloadCommand handles the reload command.

func (s *Service) Stop() error

Stop disables remote access.

func (s *Service) UpdateState(ctx context.Context, edgeURL string, enabled bool) error

UpdateState ensures that remote access is enabled or disabled based on the enabled parameter.

func (s *Service) WithConfigReloadNotifier(ch chan bool) *Service

WithConfigReloadNotifier registers a channel to be notified when a remote configuration reload is requested.

func (s *Service) WithTLSConfig(tlsConfig *tls.Config) *Service

WithTLSConfig sets the TLS configuration for the remote access service.