Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.benzinga.com/llms.txt

Use this file to discover all available pages before exploring further.

Repositorio de GitHub

Ver código fuente y contribuir

​
Características

  • Probado con Go 1.13 o superior
  • Implementación de alto rendimiento
  • Sin dependencias externas
  • Utiliza la biblioteca context de Go para la cancelación

​
Instalación

Instala la biblioteca y el cliente de ejemplo: 
go install github.com/Benzinga/go-bztcp/cmd/bztcp@latest
El binario bztcp se instalará en $GOPATH/bin.

​
Inicio rápido

Prueba el cliente con el ejecutable incluido: 
bztcp -v -user YOUR_USERNAME -key YOUR_API_KEY

​
Opciones de línea de comandos

OpciónDescripción
-userTu nombre de usuario TCP de Benzinga
-keyTu clave de acceso a la API
-vHabilita la salida detallada
Si se ejecuta correctamente, verás mensajes similares a: 
Benzinga TCP Client initializing.
Connecting to 'tcp-v1.benzinga.io:11337' as user 'YOUR_USERNAME' (w/TLS: false)
Connected. Waiting for events.
{"id":49917328,"title":"Alphabet Option Alert..."}

​
Uso de la librería

​
Funciones principales

La biblioteca expone dos funciones principales:
FunciónDescripción
bztcp.Dial(addr, user, key)Establece una conexión con el servidor TCP
Conn.Stream(ctx, callback)Inicia la transmisión de mensajes con un callback

​
Ejemplo básico

package main

import (
	"context"
	"fmt"

	"github.com/Benzinga/go-bztcp/bztcp"
)

func main() {
	// Conectarse al servidor
	conn, err := bztcp.Dial("tcp-v1.benzinga.io:11337", "USER", "KEY")
	if err != nil {
		panic(err)
	}

	// Transmitir mensajes en streaming
	err = conn.Stream(context.Background(), func(stream bztcp.StreamData) {
		fmt.Printf("%#v\n", stream)
	})

	if err != nil {
		panic(err)
	}
}

​
Uso avanzado

​
Cancelación basada en contexto

Use el contexto de Go para un cierre ordenado: 
package main

import (
	"context"
	"fmt"
	"os"
	"os/signal"
	"syscall"

	"github.com/Benzinga/go-bztcp/bztcp"
)

func main() {
	conn, err := bztcp.Dial("tcp-v1.benzinga.io:11337", "USER", "KEY")
	if err != nil {
		panic(err)
	}

	// Crear contexto cancelable
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// Gestionar señales de cierre
	sigChan := make(chan os.Signal, 1)
	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
	
	go func() {
		<-sigChan
		fmt.Println("Cerrando...")
		cancel()
	}()

	// Transmitir con contexto
	err = conn.Stream(ctx, func(stream bztcp.StreamData) {
		fmt.Printf("Recibido: %s\n", stream.Title)
	})

	if err != nil && err != context.Canceled {
		fmt.Printf("Error: %v\n", err)
	}
}

​
Procesamiento de datos del stream

La estructura StreamData contiene el mensaje ya analizado: 
conn.Stream(ctx, func(stream bztcp.StreamData) {
	// Acceder a los campos del mensaje
	fmt.Printf("ID: %d\n", stream.ID)
	fmt.Printf("Title: %s\n", stream.Title)
	fmt.Printf("Published: %s\n", stream.Published)
	
	// Procesar tickers
	for _, ticker := range stream.Tickers {
		fmt.Printf("Ticker: %s\n", ticker.Name)
	}
	
	// Procesar canales
	for _, channel := range stream.Channels {
		fmt.Printf("Channel: %s\n", channel)
	}
})

​
Gestión de errores

conn, err := bztcp.Dial("tcp-v1.benzinga.io:11337", "USER", "KEY")
if err != nil {
	log.Fatalf("Fallo al conectar: %v", err)
}

err = conn.Stream(ctx, handler)
if err != nil {
	switch {
	case err == context.Canceled:
		log.Println("Stream cancelado por el usuario")
	case err == context.DeadlineExceeded:
		log.Println("Tiempo de espera del stream agotado")
	default:
		log.Printf("Error de stream: %v", err)
	}
}

​
Ejemplo completo

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"
	"os/signal"
	"syscall"

	"github.com/Benzinga/go-bztcp/bztcp"
)

func main() {
	user := os.Getenv("BZTCP_USER")
	key := os.Getenv("BZTCP_KEY")

	if user == "" || key == "" {
		log.Fatal("Establece las variables de entorno BZTCP_USER y BZTCP_KEY")
	}

	conn, err := bztcp.Dial("tcp-v1.benzinga.io:11337", user, key)
	if err != nil {
		log.Fatalf("Connection failed: %v", err)
	}

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// Graceful shutdown
	sigChan := make(chan os.Signal, 1)
	signal.Notify(sigChan, syscall.SIGINT, syscall.SIGTERM)
	go func() {
		<-sigChan
		fmt.Println("\nShutting down gracefully...")
		cancel()
	}()

	fmt.Println("Starting Benzinga TCP stream...")

	err = conn.Stream(ctx, func(stream bztcp.StreamData) {
		// Pretty print the message
		data, _ := json.MarshalIndent(stream, "", "  ")
		fmt.Println(string(data))
	})

	if err != nil && err != context.Canceled {
		log.Printf("Stream ended with error: %v", err)
	}
}

​
Requisitos

  • Go 1.13 o posterior (usa el paquete context, requiere Go 1.8 o superior)
  • Acceso de red a tcp-v1.benzinga.io:11337

​
Consulta también