Documentation
¶
Index ¶
- func CloseSession(ac *client.AlpaconClient, sessionID string) error
- func ForceCloseSession(ac *client.AlpaconClient, sessionID string) error
- func GetSessionDetail(ac *client.AlpaconClient, sessionID string) ([]byte, error)
- func InviteToSession(ac *client.AlpaconClient, sessionID string, emails []string, readOnly bool) error
- func OpenNewTerminal(ac *client.AlpaconClient, sessionResponse SessionResponse) error
- func OpenReadOnlyTerminal(ac *client.AlpaconClient, sessionResponse SessionResponse) error
- type ConnectRequest
- type InviteRequest
- type JoinRequest
- type SessionDetailResponse
- type SessionListItem
- type SessionRequest
- type SessionResponse
- func ConnectToSession(ac *client.AlpaconClient, sessionID string) (SessionResponse, error)
- func CreateWebshSession(ac *client.AlpaconClient, serverName, username, groupname string, ...) (SessionResponse, error)
- func JoinWebshSession(ac *client.AlpaconClient, sharedURL, password string) (SessionResponse, error)
- type ShareRequest
- type ShareResponse
- type WebsocketClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CloseSession ¶ added in v1.3.4
func CloseSession(ac *client.AlpaconClient, sessionID string) error
func ForceCloseSession ¶ added in v1.3.4
func ForceCloseSession(ac *client.AlpaconClient, sessionID string) error
func GetSessionDetail ¶ added in v1.3.4
func GetSessionDetail(ac *client.AlpaconClient, sessionID string) ([]byte, error)
func InviteToSession ¶ added in v1.3.4
func OpenNewTerminal ¶
func OpenNewTerminal(ac *client.AlpaconClient, sessionResponse SessionResponse) error
Handles graceful termination of the websh terminal. Exits on error without further error handling.
func OpenReadOnlyTerminal ¶ added in v1.3.4
func OpenReadOnlyTerminal(ac *client.AlpaconClient, sessionResponse SessionResponse) error
OpenReadOnlyTerminal opens a read-only terminal view for watching another user's session. Input is not forwarded to the server. Terminal echo is suppressed via raw mode. Exits cleanly on Ctrl+C or SIGTERM.
Types ¶
type ConnectRequest ¶ added in v1.3.4
type InviteRequest ¶ added in v1.3.4
type JoinRequest ¶
type JoinRequest struct {
Password string `json:"password"`
}
type SessionDetailResponse ¶ added in v1.3.4
type SessionDetailResponse struct {
ID string `json:"id"`
Rows int `json:"rows"`
Cols int `json:"cols"`
Server types.ServerSummary `json:"server"`
User types.UserSummary `json:"user"`
Username string `json:"username"`
Groupname string `json:"groupname"`
UserAgent string `json:"user_agent"`
RemoteIP string `json:"remote_ip"`
IsTunnel bool `json:"is_tunnel"`
ClientType string `json:"client_type"`
AddedAt string `json:"added_at"`
UpdatedAt string `json:"updated_at"`
ClosedAt *string `json:"closed_at"`
Success bool `json:"success"`
}
type SessionListItem ¶ added in v1.3.4
type SessionListItem struct {
ID string `table:"ID"`
Server string `table:"Server"`
User string `table:"User"`
Username string `table:"Username"`
RemoteIP string `table:"Remote IP"`
AddedAt string `table:"Added At"`
ClosedAt string `table:"Closed At"`
}
func GetSessionList ¶ added in v1.3.4
func GetSessionList(ac *client.AlpaconClient) ([]SessionListItem, error)
type SessionRequest ¶
type SessionResponse ¶
type SessionResponse struct {
ID string `json:"id"`
Rows int `json:"rows"`
Cols int `json:"cols"`
Server types.ServerSummary `json:"server"`
User types.UserSummary `json:"user"`
Username string `json:"username"`
Groupname string `json:"groupname"`
UserAgent string `json:"user_agent"`
RemoteIP string `json:"remote_ip"`
WebsocketURL string `json:"websocket_url"`
}
func ConnectToSession ¶ added in v1.3.4
func ConnectToSession(ac *client.AlpaconClient, sessionID string) (SessionResponse, error)
func CreateWebshSession ¶
func CreateWebshSession(ac *client.AlpaconClient, serverName, username, groupname string, share, readOnly bool) (SessionResponse, error)
Create new websh session
func JoinWebshSession ¶
func JoinWebshSession(ac *client.AlpaconClient, sharedURL, password string) (SessionResponse, error)
type ShareRequest ¶
type ShareRequest struct {
}
type ShareResponse ¶
type ShareResponse struct {
}
type WebsocketClient ¶
Click to show internal directories.
Click to hide internal directories.