Method ConnectDesktopVNC

codersdk/workspacesdk/agentconn.go:599–631

ConnectDesktopVNC opens a WebSocket to the agent's desktop endpoint and returns a net.Conn carrying raw RFB (VNC) binary data.

(ctx context.Context)

// ConnectDesktopVNC opens a WebSocket to the agent's desktop endpoint and
// returns a net.Conn carrying raw RFB (VNC) binary data.
func (c *agentConn) ConnectDesktopVNC(ctx context.Context) (net.Conn, error) {
	ctx, span := tracing.StartSpan(ctx)
	defer span.End()

	host := net.JoinHostPort(c.agentAddress().String(), strconv.Itoa(AgentHTTPAPIServerPort))

	dialOpts := &websocket.DialOptions{
		HTTPClient:      c.apiClient(),
		CompressionMode: websocket.CompressionDisabled,
	}
	c.headersMu.RLock()
	if len(c.extraHeaders) > 0 {
		dialOpts.HTTPHeader = c.extraHeaders.Clone()
	}
	c.headersMu.RUnlock()

	url := fmt.Sprintf("http://%s/api/v0/desktop/vnc", host)
	conn, res, err := websocket.Dial(ctx, url, dialOpts)
	if err != nil {
		if res == nil {
			return nil, err
		}
		return nil, codersdk.ReadBodyAsError(res)
	}
	if res != nil && res.Body != nil {
		defer res.Body.Close()
	}

	// No read limit — RFB framebuffer updates can be large.
	conn.SetReadLimit(-1)

	return websocket.NetConn(ctx, conn, websocket.MessageBinary), nil
}

// DesktopAction is the request body for the desktop action
// endpoint.