telex

package module

v0.0.0-...-33cf3d0 Latest Latest Go to latest Published: Mar 25, 2021 License: MIT Imports: 7 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/qrdl/telex

Documentation ¶

Overview ¶

package telex executes process and streams process output to clients

Index ¶

Constants
func GetOutputStream(cache *JobCache, ctx context.Context, handle string, streamType int) (<-chan string, error)
func Kill(cache *JobCache, handle string) error
func StartProcess(cache *JobCache, cmdLine string, user string, mountPoint ...string) (string, error)
func Status(cache *JobCache, handle string) (status int, owner string, exitcode int, err error)
type JobCache
- func New() *JobCache

Constants ¶

View Source

const (
	StatusInvalid = iota
	StatusRunning
	StatusCompleted
	StatusFailed
	StatusKilled
)

Process status codes

View Source

const (
	StreamStdout
	StreamStderr
)

Output stream types

Variables ¶

This section is empty.

Functions ¶

func GetOutputStream ¶

func GetOutputStream(cache *JobCache, ctx context.Context, handle string, streamType int) (<-chan string, error)

GetOutputStream returns channel the client can read process output from. The channel will be closed when all output of the process is delivered. Client can cancel the stream using context. It is a responsibility of the caller to check whether process belongs to the user.

func Kill ¶

func Kill(cache *JobCache, handle string) error

Kill kills the process, if it is running. It is a responsibility of the caller to check whether process belongs to the user.

func StartProcess ¶

func StartProcess(cache *JobCache, cmdLine string, user string, mountPoint ...string) (string, error)

StartProcess starts execution of provided command, returns process handle or error.

func Status ¶

func Status(cache *JobCache, handle string) (status int, owner string, exitcode int, err error)

Status returns the status, owner and exitcode of the process. It is a responsibility of the caller to check whether process belongs to the user.

Types ¶

type JobCache ¶

type JobCache struct {
	sync.RWMutex // mutex to allow safely adding new records to runLog
	// contains filtered or unexported fields
}

func New ¶

func New() *JobCache

Source Files ¶

View all Source files

telex.go

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