Consulte workspaces pela Socket API

A CLI e a Socket API consultam o mesmo servidor. A API é útil para um programa que precisa enviar mensagens JSON diretamente. Para comandos de terminal, a CLI já prepara essas mensagens.

Localize o socket

Dentro de um painel do Herdr, a variável HERDR_SOCKET_PATH identifica o socket da sessão. O exemplo abaixo usa sockets Unix no Linux. Ele não implementa o transporte de named pipes do Windows.

Envie uma consulta

Crie o arquivo consultar.mjs e execute com Node.js dentro do painel:

1
import net from 'node:net'
2

3
const path = process.env.HERDR_SOCKET_PATH
4
if (!path) throw new Error('Execute dentro de um painel do Herdr.')
5
const socket = net.createConnection(path)
6
let buffer = ''
7
socket.setTimeout(5000)
8
socket.on('connect', () => socket.write(JSON.stringify({
9
  id: 'consulta', method: 'workspace.list', params: {}
10
}) + '\n'))
11
socket.on('data', chunk => {
12
  buffer += chunk.toString()
13
  const end = buffer.indexOf('\n')
14
  if (end < 0) return
15
  const response = JSON.parse(buffer.slice(0, end))
16
  if (response.id !== 'consulta' || response.error) process.exitCode = 1
17
  console.log(response)
18
  socket.end()
19
})
20
socket.on('timeout', () => {
21
  console.error('O servidor não respondeu em cinco segundos.')
22
  process.exitCode = 1
23
  socket.destroy()
24
})
25
socket.on('error', error => {
26
  console.error(error.message)
27
  process.exitCode = 1
28
})

A resposta deve ter o mesmo ID e um resultado do tipo workspace_list. A consulta foi executada contra o servidor 0.9.5 no Linux e retornou os workspaces da sessão de laboratório.

Confira o protocolo instalado

1
herdr api schema --json

Use o schema da versão instalada ao acrescentar métodos. O exemplo abre uma conexão para uma consulta e a encerra depois da resposta. Assinaturas de eventos exigem tratamento de várias mensagens e reconexão.