Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

session

package

Go to main page

Versions in this module

v1

v1.0.3

Mar 14, 2024

v1.0.2

Feb 27, 2024

Changes in this version

+ func StopSessionById(sessionId string) error

v1.0.1

Jan 23, 2024

v1.0.0

Nov 16, 2023

v0

v0.1.0

Nov 6, 2023

Changes in this version

+ const ACKSlidingWindowRecv

+ const ACKSlidingWindowSend

+ const ErrorMessage

+ const FileTransferBufSize

+ const MaxTraceback

+ const NoExpirationTimeout

+ const NormalMessage

+ var ErrNoSession = errors.New("session: does not exist")

+ var ErrNoSessionID = errors.New("session: message does not have a session ID")

+ var ErrSessionNotFound = errors.New("session not found")

+ var ErrSessionShellAlreadyRunning = errors.New("shell is already running")

+ var ErrSessionShellNotRunning = errors.New("shell is not running")

+ var ErrSessionShellTooManySessionsPerUser = errors.New("user has too many open sessions")

+ var ErrSessionTooManyShellsAlreadyRunning = errors.New("too many shells spawned")

+ var MaxUserSessions = 1

+ func DeleteSessionById(id string) error

+ func GetSessionCount() int

+ func GetSessionIds() []string

+ func StopSessionByUserId(userId string) (count uint, err error)

+ func TerminateAllSessions() (shellCount int, sessionCount int, err error)

+ func TerminateExpiredSessions() (shellCount int, sessionCount int, totalExpiredLeft int, err error)

+ type Config struct

+ IdleTimeout time.Duration

+ type Constructor func() SessionHandler

+ func FileTransfer(root string, limits config.Limits) Constructor

+ func MenderClient() Constructor

+ func PortForward() Constructor

+ type FileTransferHandler struct

+ func (h *FileTransferHandler) Close() error

+ func (h *FileTransferHandler) DownloadHandler(fd *os.File, msg *ws.ProtoMsg, w api.Sender) (err error)

+ func (h *FileTransferHandler) Error(msg *ws.ProtoMsg, w api.Sender, err error)

+ func (h *FileTransferHandler) FileUploadHandler(msg *ws.ProtoMsg, params model.UploadRequest, dstPath string, w api.Sender) (err error)

+ func (h *FileTransferHandler) InitFileDownload(msg *ws.ProtoMsg, w api.Sender) (err error)

+ func (h *FileTransferHandler) InitFileUpload(msg *ws.ProtoMsg, w api.Sender) (err error)

+ func (h *FileTransferHandler) ServeProtoMsg(msg *ws.ProtoMsg, w api.Sender)

+ func (h *FileTransferHandler) StatFile(msg *ws.ProtoMsg, w api.Sender)

+ type HandlerFunc func(msg *ws.ProtoMsg, w api.Sender)

+ func (h HandlerFunc) Close() error

+ func (h HandlerFunc) ServeProtoMsg(msg *ws.ProtoMsg, w api.Sender)

+ type PortForwardHandler struct

+ func (h *PortForwardHandler) Close() error

+ func (h *PortForwardHandler) ServeProtoMsg(msg *ws.ProtoMsg, w api.Sender)

+ type PortForwarder struct

+ ConnectionID string

+ Sender api.Sender

+ SessionID string

+ func (f *PortForwarder) Close(sendStopMessage bool) error

+ func (f *PortForwarder) Connect(protocol string, host string, portNumber uint16) error

+ func (f *PortForwarder) Read()

+ func (f *PortForwarder) Write(body []byte) error

+ type ProtoRoutes map[ws.ProtoType]Constructor

+ type Router interface

+ RouteMessage func(msg *ws.ProtoMsg, w api.Sender) error

+ func NewRouter(routes ProtoRoutes, config Config) Router

+ type Session struct

+ ID string

+ Routes ProtoRoutes

+ func New(sessionID string, msgChan chan *ws.ProtoMsg, w api.Sender, routes ProtoRoutes, ...) *Session

+ func (sess *Session) Done() <-chan struct{}

+ func (sess *Session) Error(msg *ws.ProtoMsg, close bool, errMessage string)

+ func (sess *Session) HandleControl(msg *ws.ProtoMsg) (close bool)

+ func (sess *Session) ListenAndServe()

+ func (sess *Session) MsgChan() chan<- *ws.ProtoMsg

+ func (sess *Session) Ping() error

+ type SessionHandler interface

+ Close func() error

+ ServeProtoMsg func(msg *ws.ProtoMsg, w api.Sender)

+ type SessionStatus int

+ const SessionStatusActive

+ const SessionStatusEmpty

+ const SessionStatusExpired

+ const SessionStatusHanged

+ const SessionStatusIdle

+ const SessionStatusNew

+ type TerminalSession struct

+ func GetSessionById(id string) *TerminalSession

+ func GetSessionsByUserId(userId string) []*TerminalSession

+ func NewShellSession(sock api.Sender, sessionId string, userId string, expireAfter time.Duration, ...) (s *TerminalSession, err error)

+ func (s *TerminalSession) GetActiveAtFmt() string

+ func (s *TerminalSession) GetExpiresAtFmt() string

+ func (s *TerminalSession) GetId() string

+ func (s *TerminalSession) GetShellCommandPath() string

+ func (s *TerminalSession) GetShellPid() int

+ func (s *TerminalSession) GetStartedAtFmt() string

+ func (s *TerminalSession) GetStatus() SessionStatus

+ func (s *TerminalSession) HealthcheckPong()

+ func (s *TerminalSession) IsExpired(setStatus bool) bool

+ func (s *TerminalSession) ResizeShell(height, width uint16)

+ func (s *TerminalSession) ShellCommand(m *ws.ProtoMsg) error

+ func (s *TerminalSession) StartShell(sock api.Sender, sessionId string, terminal TerminalSettings) error

+ func (s *TerminalSession) StopShell() (err error)

+ type TerminalSettings struct

+ Gid uint32

+ Height uint16

+ HomeDir string

+ Shell string

+ ShellArguments []string

+ TerminalString string

+ Uid uint32

+ Width uint16