pty

package

v0.0.0-...-97c4edd Latest Latest Go to latest Published: Apr 19, 2021 License: MPL-2.0 Imports: 8 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.

func Start(shell string) (*os.File, error)

Start starts and returns an open PTY session with the given shell command.

func Verify(shell string) error

Verify verifies the given shell command, returning an error if invalid.

type BaseSession interface {
	SessionID() string
	Session() *os.File
	Out() *broadcast.Broadcaster
	Execute(string) error
	Close()
}

BaseSession allows communcation with a PTY session.

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

Session is a PTY that allows command execution through Session.Execute while sending output through the Session.Out channel.

func CreateSession(sessionID, shell string) (*Session, error)

CreateSession creates a new Session injected with the given sessionID, the given shell and defaults.

func (ptySession *Session) Close()

Close schedules the session for closure

func (ptySession *Session) Execute(toBeExecuted string) error

Execute executes toBeExecuted in the pty. Output is written to Session.Out.

func (ptySession *Session) Out() *broadcast.Broadcaster

Out returns a broadcaster used for communicating output to command execution in the PTY.

func (ptySession *Session) Session() *os.File

Session returns the inner pty.

func (ptySession *Session) SessionID() string

SessionID returns the sessionID