Documentation
¶
Index ¶
- Constants
- func BinaryHash(path string) (string, error)
- func DefaultRecordDir() (string, error)
- func DefaultSocketPath() (string, error)
- func DefaultTranscriptDir() (string, error)
- func FindSessiondBinary() (string, error)
- func WaitForShutdown(ctx context.Context, socketPath string) error
- type AttachRequest
- type Client
- func (c *Client) Attach(ctx context.Context, sessionID string, since int64, withBuffer bool, ...) (*Stream, StreamMessage, error)
- func (c *Client) Create(ctx context.Context, sessionID, cwd string) (CreateResponse, error)
- func (c *Client) GetOwner(ctx context.Context, sessionID string) (OwnerResponse, error)
- func (c *Client) Info(ctx context.Context) (InfoResponse, error)
- func (c *Client) List(ctx context.Context) (ListResponse, error)
- func (c *Client) Ping(ctx context.Context) error
- func (c *Client) Resize(ctx context.Context, sessionID string, cols, rows int) error
- func (c *Client) Send(ctx context.Context, sessionID, data string) error
- func (c *Client) SendWithOwner(ctx context.Context, sessionID, data, owner string) error
- func (c *Client) SetOwner(ctx context.Context, sessionID, owner string) error
- func (c *Client) Shutdown(ctx context.Context) error
- func (c *Client) ShutdownWithReason(ctx context.Context, source, reason string) error
- func (c *Client) Stop(ctx context.Context, sessionID string) error
- type ControlRequest
- type ControlResponse
- type CreateRequest
- type CreateResponse
- type InfoResponse
- type ListResponse
- type Options
- type OwnerRequest
- type OwnerResponse
- type ResizeRequest
- type SendRequest
- type Server
- type Session
- type SessionInfo
- type ShutdownRequest
- type StartOptions
- type StopRequest
- type Stream
- type StreamMessage
Constants ¶
View Source
const ProtocolVersion = 2
Variables ¶
This section is empty.
Functions ¶
func BinaryHash ¶
func DefaultRecordDir ¶
func DefaultSocketPath ¶
func DefaultTranscriptDir ¶
func FindSessiondBinary ¶
Types ¶
type AttachRequest ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func EnsureRunningWithOptions ¶
func EnsureRunningWithOptions(ctx context.Context, opts StartOptions) (*Client, error)
func (*Client) SendWithOwner ¶
func (*Client) ShutdownWithReason ¶
type ControlRequest ¶
type ControlRequest struct {
ProtocolVersion int `json:"protocolVersion"`
Method string `json:"method"`
Params json.RawMessage `json:"params,omitempty"`
}
type ControlResponse ¶
type CreateRequest ¶
type CreateResponse ¶
type InfoResponse ¶
type ListResponse ¶
type ListResponse struct {
Sessions []SessionInfo `json:"sessions"`
}
type Options ¶
type Options struct {
SocketPath string
TranscriptDir string
RecordDir string
IdleTimeout time.Duration
BufferBytes int
TranscriptMaxBytes int64
TranscriptTrimThreshold int64
TranscriptTailBytes int64
RecordPty bool
Logger *log.Logger
ProtocolLogEnabled bool
ProtocolLogDir string
ProtocolLogger *unifiedlog.Logger
}
func DefaultOptions ¶
func DefaultOptions() Options
type OwnerRequest ¶
type OwnerResponse ¶
type ResizeRequest ¶
type SendRequest ¶
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
func (*Server) SetShutdown ¶
func (s *Server) SetShutdown(fn func())
type SessionInfo ¶
type ShutdownRequest ¶
type StartOptions ¶
type StopRequest ¶
type StopRequest struct {
SessionID string `json:"sessionId"`
}
Click to show internal directories.
Click to hide internal directories.