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

workspacesdk

package

Go to main page

Versions in this module

v2

v2.11.2

May 22, 2024

v2.11.1

May 16, 2024

v2.11.0

May 6, 2024

Changes in this version

type DialAgentOptions

+ CaptureHook capture.Callback

v2.10.3

May 22, 2024

v2.10.2

Apr 22, 2024

v2.10.1

Apr 17, 2024

v2.10.0

Apr 3, 2024

Changes in this version

+ const AgentHTTPAPIServerPort

+ const AgentMinimumListeningPort

+ const AgentReconnectingPTYPort

+ const AgentSSHPort

+ const AgentSpeedtestPort

+ var AgentIP = netip.MustParseAddr("fd7a:115c:a1e0:49d6:b259:b7ac:b1b2:48f4")

+ var AgentIgnoredListeningPorts = map[uint16]struct

+ var ErrSkipClose = xerrors.New("skip tailnet close")

+ type AgentConn struct

+ func NewAgentConn(conn *tailnet.Conn, opts AgentConnOptions) *AgentConn

+ func (c *AgentConn) AwaitReachable(ctx context.Context) bool

+ func (c *AgentConn) Close() error

+ func (c *AgentConn) DebugLogs(ctx context.Context) ([]byte, error)

+ func (c *AgentConn) DebugMagicsock(ctx context.Context) ([]byte, error)

+ func (c *AgentConn) DebugManifest(ctx context.Context) ([]byte, error)

+ func (c *AgentConn) DialContext(ctx context.Context, network string, addr string) (net.Conn, error)

+ func (c *AgentConn) GetPeerDiagnostics() tailnet.PeerDiagnostics

+ func (c *AgentConn) ListeningPorts(ctx context.Context) (codersdk.WorkspaceAgentListeningPortsResponse, error)

+ func (c *AgentConn) Ping(ctx context.Context) (time.Duration, bool, *ipnstate.PingResult, error)

+ func (c *AgentConn) PrometheusMetrics(ctx context.Context) ([]byte, error)

+ func (c *AgentConn) ReconnectingPTY(ctx context.Context, id uuid.UUID, height, width uint16, command string) (net.Conn, error)

+ func (c *AgentConn) SSH(ctx context.Context) (*gonet.TCPConn, error)

+ func (c *AgentConn) SSHClient(ctx context.Context) (*ssh.Client, error)

+ func (c *AgentConn) Speedtest(ctx context.Context, direction speedtest.Direction, duration time.Duration) ([]speedtest.Result, error)

+ type AgentConnOptions struct

+ AgentID uuid.UUID

+ CloseFunc func() error

+ type AgentConnectionInfo struct

+ DERPForceWebSockets bool

+ DERPMap *tailcfg.DERPMap

+ DisableDirectConnections bool

+ type AgentReconnectingPTYInit struct

+ Command string

+ Height uint16

+ ID uuid.UUID

+ Width uint16

+ type Client struct

+ func New(c *codersdk.Client) *Client

+ func (c *Client) AgentConnectionInfo(ctx context.Context, agentID uuid.UUID) (AgentConnectionInfo, error)

+ func (c *Client) AgentConnectionInfoGeneric(ctx context.Context) (AgentConnectionInfo, error)

+ func (c *Client) AgentReconnectingPTY(ctx context.Context, opts WorkspaceAgentReconnectingPTYOpts) (net.Conn, error)

+ func (c *Client) DialAgent(dialCtx context.Context, agentID uuid.UUID, options *DialAgentOptions) (agentConn *AgentConn, err error)

+ type DialAgentOptions struct

+ BlockEndpoints bool

+ Logger slog.Logger

+ type ReconnectingPTYRequest struct

+ Data string

+ Height uint16

+ Width uint16

+ type WorkspaceAgentReconnectingPTYOpts struct

+ AgentID uuid.UUID

+ Command string

+ Height uint16

+ Reconnect uuid.UUID

+ SignedToken string

+ Width uint16