Saltar al contenido principal
Utilidades robustas de transmisión en tiempo real para el SDK de X API. Este módulo proporciona gestión de conexiones de transmisión en tiempo real con reconexión automática, backoff exponencial y manejo exhaustivo de errores. Los clientes pueden consumir endpoints de transmisión en tiempo real sin preocuparse por la gestión de la conexión: el SDK se encarga de todo el restablecimiento de forma automática.

class xdk.streaming.StreamConfig

Configuración para conexiones de streaming con lógica de reintento.

Parámetros

path.max_retries
int
predeterminado:"10"
path.initial_backoff
float
predeterminado:"1.0"
path.max_backoff
float
predeterminado:"64.0"
path.backoff_multiplier
float
predeterminado:"2.0"
path.jitter
bool
predeterminado:"True"
path.timeout
float or None
predeterminado:"None"
path.chunk_size
int
predeterminado:"1024"
path.on_connect
Callable[[], None] or None
predeterminado:"None"
path.on_disconnect
Callable[[Exception or None], None] or None
predeterminado:"None"
path.on_reconnect
Callable[[int, float], None] or None
predeterminado:"None"
path.on_error
Callable[[[StreamError

__init__

Parámetros

path.max_retries
int
predeterminado:"10"
path.initial_backoff
float
predeterminado:"1.0"
path.max_backoff
float
predeterminado:"64.0"
path.backoff_multiplier
float
predeterminado:"2.0"
path.jitter
bool
predeterminado:"True"
path.timeout
float or None
predeterminado:"None"
path.chunk_size
int
predeterminado:"1024"
path.on_connect
Callable[[], None] or None
predeterminado:"None"
path.on_disconnect
Callable[[Exception or None], None] or None
predeterminado:"None"
path.on_reconnect
Callable[[int, float], None] or None
predeterminado:"None"
path.on_error
Callable[[[StreamError

on_error : Callable[[[StreamError]

exception xdk.streaming.StreamError

Excepción que se lanza para errores de streaming con clasificación.

Parámetros

path.message
str
path.error_type
StreamErrorType

__init__

Parámetros

path.message
str
path.error_type
StreamErrorType

class xdk.streaming.StreamErrorType

Clasificación de errores de streaming para tomar decisiones de reintento.

Parámetros

path.value
Any

class xdk.streaming.StreamState

Estado interno de una conexión de streaming.

Parámetros

path.retry_count
int
predeterminado:"0"
path.current_backoff
float
predeterminado:"1.0"
path.is_connected
bool
predeterminado:"False"
path.total_items_received
int
predeterminado:"0"
path.last_error
StreamError

__init__

Parámetros

path.retry_count
int
predeterminado:"0"
path.current_backoff
float
predeterminado:"1.0"
path.is_connected
bool
predeterminado:"False"
path.total_items_received
int
predeterminado:"0"
path.last_error
StreamError

last_error : [StreamError]

xdk.streaming.stream_with_retry

Transmite datos desde un endpoint con reconexión automática y backoff exponencial. Esta función gestiona toda la conexión, incluyendo:
  • Reconexión automática ante desconexiones
  • Backoff exponencial con jitter para los retrasos entre reintentos
  • Clasificación de errores como reintentables o fatales
  • Callbacks de ciclo de vida para supervisar el estado de la conexión

Parámetros

path.session
Session
La sesión de requests que se utilizará para las llamadas HTTP.
path.method
str
Método HTTP (normalmente «GET»).
path.url
str
La URL completa desde la que se hará streaming.
path.config
StreamConfig
StreamConfig con configuración de reintentos y callbacks.