func ExistsViaCoderConnect(ctxcontext.Context, hostnamestring) (bool,error)

func WithTestOnlyCoderContextResolver(ctxcontext.Context, rResolver)context.Context

type AgentConn interface {TailnetConn() *tailnet.ConnAwaitReachable(ctxcontext.Context)boolClose()errorDebugLogs(ctxcontext.Context) ([]byte,error)DebugMagicsock(ctxcontext.Context) ([]byte,error)DebugManifest(ctxcontext.Context) ([]byte,error)DialContext(ctxcontext.Context, networkstring, addrstring) (net.Conn,error)GetPeerDiagnostics()tailnet.PeerDiagnosticsListContainers(ctxcontext.Context) (codersdk.WorkspaceAgentListContainersResponse,error)ListeningPorts(ctxcontext.Context) (codersdk.WorkspaceAgentListeningPortsResponse,error)Netcheck(ctxcontext.Context) (healthsdk.AgentNetcheckReport,error)Ping(ctxcontext.Context) (time.Duration,bool, *ipnstate.PingResult,error)PrometheusMetrics(ctxcontext.Context) ([]byte,error)ReconnectingPTY(ctxcontext.Context, iduuid.UUID, heightuint16, widthuint16, commandstring, initOpts ...AgentReconnectingPTYInitOption) (net.Conn,error)RecreateDevcontainer(ctxcontext.Context, devcontainerIDstring) (codersdk.Response,error)SSH(ctxcontext.Context) (*gonet.TCPConn,error)SSHClient(ctxcontext.Context) (*ssh.Client,error)SSHClientOnPort(ctxcontext.Context, portuint16) (*ssh.Client,error)SSHOnPort(ctxcontext.Context, portuint16) (*gonet.TCPConn,error)Speedtest(ctxcontext.Context, directionspeedtest.Direction, durationtime.Duration) ([]speedtest.Result,error)WatchContainers(ctxcontext.Context, loggerslog.Logger) (<-chancodersdk.WorkspaceAgentListContainersResponse,io.Closer,error)}

funcNewAgentConn¶

func NewAgentConn(conn *tailnet.Conn, optsAgentConnOptions)AgentConn

NewAgentConn creates a new WorkspaceAgentConn. `conn` may be uniqueto the WorkspaceAgentConn, or it may be shared in the case of coderd. If theconn is shared and closing it is undesirable, you may return ErrNoClose fromopts.CloseFunc. This will ensure the underlying conn is not closed.

type AgentConnOptions struct {AgentIDuuid.UUIDCloseFunc func()error}

type AgentConnectionInfo struct {DERPMap                  *tailcfg.DERPMap `json:"derp_map"`DERPForceWebSocketsbool             `json:"derp_force_websockets"`DisableDirectConnectionsbool             `json:"disable_direct_connections"`HostnameSuffixstring           `json:"hostname_suffix,omitempty"`}

type AgentReconnectingPTYInit struct {IDuuid.UUIDHeightuint16Widthuint16Commandstring// Container, if set, will attempt to exec into a running container visible to the agent.// This should be a unique container ID (implementation-dependent).Containerstring// ContainerUser, if set, will set the target user when execing into a container.// This can be a username or UID, depending on the underlying implementation.// This is ignored if Container is not set.ContainerUserstringBackendTypestring}

type AgentReconnectingPTYInitOption func(*AgentReconnectingPTYInit)

funcAgentReconnectingPTYInitWithContainer¶added inv2.21.0

func AgentReconnectingPTYInitWithContainer(container, containerUserstring)AgentReconnectingPTYInitOption

AgentReconnectingPTYInitWithContainer sets the container and container user for the reconnecting PTY session.

type Client struct {// contains filtered or unexported fields}

funcNew¶

func New(c *codersdk.Client) *Client

func (*Client)AgentConnectionInfo¶

func (c *Client) AgentConnectionInfo(ctxcontext.Context, agentIDuuid.UUID) (AgentConnectionInfo,error)

func (*Client)AgentConnectionInfoGeneric¶

func (c *Client) AgentConnectionInfoGeneric(ctxcontext.Context) (AgentConnectionInfo,error)

func (*Client)AgentReconnectingPTY¶

func (c *Client) AgentReconnectingPTY(ctxcontext.Context, optsWorkspaceAgentReconnectingPTYOpts) (net.Conn,error)

AgentReconnectingPTY spawns a PTY that reconnects using the token provided.It communicates using `agent.ReconnectingPTYRequest` marshaled as JSON.Responses are PTY output that can be rendered.

func (*Client)DialAgent¶

func (c *Client) DialAgent(dialCtxcontext.Context, agentIDuuid.UUID, options *DialAgentOptions) (agentConnAgentConn, errerror)

func (*Client)IsCoderConnectRunning¶added inv2.22.0

func (c *Client) IsCoderConnectRunning(ctxcontext.Context, oCoderConnectQueryOptions) (bool,error)

IsCoderConnectRunning checks if Coder Connect (OS level tunnel to workspaces) is running on the system. If youalready know the hostname suffix your deployment uses, you can pass it in the CoderConnectQueryOptions to avoid anAPI call to AgentConnectionInfoGeneric.

func (*Client)RewriteDERPMap¶added inv2.25.0

func (c *Client) RewriteDERPMap(derpMap *tailcfg.DERPMap)

RewriteDERPMap rewrites the DERP map to use the configured access URL of theclient as the "embedded relay" access URL.

See tailnet.RewriteDERPMapDefaultRelay for more details on why this isnecessary.

type CoderConnectQueryOptions struct {HostnameSuffixstring}

type DialAgentOptions struct {Loggerslog.Logger// BlockEndpoints forced a direct connection through DERP. The Client may// have DisableDirect set which will override this value.BlockEndpointsbool// CaptureHook is a callback that captures Disco packets and packets sent// into the tailnet tunnel.CaptureHookcapture.Callback// Whether the client will send network telemetry events.// Enable instead of Disable so it's initialized to false (in tests).EnableTelemetrybool}

type ReconnectingPTYRequest struct {Datastring `json:"data,omitempty"`Heightuint16 `json:"height,omitempty"`Widthuint16 `json:"width,omitempty"`}

type Resolver interface {LookupIP(ctxcontext.Context, network, hoststring) ([]net.IP,error)}

type WebsocketDialer struct {// contains filtered or unexported fields}

funcNewWebsocketDialer¶added inv2.18.0

func NewWebsocketDialer(loggerslog.Logger, u *url.URL, websocketOptions *websocket.DialOptions,dialerOptions ...WebsocketDialerOption,) *WebsocketDialer

func (*WebsocketDialer)Connected¶added inv2.18.0

func (w *WebsocketDialer) Connected() <-chanerror

func (*WebsocketDialer)Dial¶added inv2.18.0

func (w *WebsocketDialer) Dial(ctxcontext.Context, rtailnet.ResumeTokenController,) (tailnet.ControlProtocolClients,error,)

type WebsocketDialerOption func(*WebsocketDialer)

funcWithWorkspaceUpdates¶added inv2.18.0

func WithWorkspaceUpdates(req *proto.WorkspaceUpdatesRequest)WebsocketDialerOption

type WorkspaceAgentReconnectingPTYOpts struct {AgentIDuuid.UUIDReconnectuuid.UUIDWidthuint16Heightuint16Commandstring// SignedToken is an optional signed token from the// issue-reconnecting-pty-signed-token endpoint. If set, the session token// on the client will not be sent.SignedTokenstring// Experimental: Container, if set, will attempt to exec into a running container// visible to the agent. This should be a unique container ID// (implementation-dependent).// ContainerUser is the user as which to exec into the container.// NOTE: This feature is currently experimental and is currently "opt-in".// In order to use this feature, the agent must have the environment variable// CODER_AGENT_DEVCONTAINERS_ENABLE set to "true".ContainerstringContainerUserstring// BackendType is the type of backend to use for the PTY. If not set, the// workspace agent will attempt to determine the preferred backend type.// Supported values are "screen" and "buffered".BackendTypestring}