streamproto

package

v0.0.0-...-5c79d48 Latest Latest Go to latest Published: Feb 15, 2024 License: AGPL-3.0 Imports: 12 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 ClientHandshake struct {
	Mode types.SessionParticipantMode `json:"mode"`
}

ClientHandshake is the first message sent by a client to inform a server of it's intentions.

type ServerHandshake struct {
	MFARequired bool `json:"mfa_required"`
}

ServerHandshake is the first message sent by a server to inform a client of the session settings.

type SessionStream struct {
	MFARequired bool
	Mode        types.SessionParticipantMode
	// contains filtered or unexported fields
}

SessionStream represents one end of the bidirectional session connection.

func NewSessionStream(conn *websocket.Conn, handshake any) (*SessionStream, error)

NewSessionStream creates a new session stream. The type of the handshake parameter determines if this is the client or server end.

func (s *SessionStream) Close() error

Close closes the stream.

func (s *SessionStream) Done() <-chan struct{}

func (s *SessionStream) ForceTerminate() error

ForceTerminate sends a force termination request to the other end.

func (s *SessionStream) ForceTerminateQueue() <-chan struct{}

ForceTerminateQueue returns the channel used for force termination requests.

func (s *SessionStream) Read(p []byte) (int, error)

func (s *SessionStream) Resize(size *remotecommand.TerminalSize) error

Resize sends a resize request to the other party.

func (s *SessionStream) ResizeQueue() <-chan *remotecommand.TerminalSize

ResizeQueue returns a channel that will receive resize requests.

func (s *SessionStream) Write(data []byte) (int, error)