sse.go (package eai)

Source : sdks/go/sse.go. Retour à l'index de la référence du SDK Go.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe SSEEvent

SSEEvent est un événement Server-Sent Events.

Champs :

Nom	Type	Requis	Description
Event	string	oui	"message" s'il est absent.
Data	string	oui	Lignes data jointes par "\n".
ID	string	oui	Valeur de la ligne id: de l'événement, vide si elle est absente.

SSEEvent.JSON

JSON(v any) error

JSON décode Data dans v.

Nom	Type	Défaut	Requis	Description
v	any		oui	Pointeur dans lequel le JSON de Data est décodé.

Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.

Erreurs levées : error.

Classe SSEStream

SSEStream lit des Server-Sent Events ; "data: [DONE]" termine le flux. Toujours le fermer avec Close.

SSEStream.Close

Close() error

Close libère la connexion.

Cet élément ne prend aucun paramètre.

Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.

Erreurs levées : error.

SSEStream.Err

Err() error

Err renvoie l'erreur de lecture, s'il y en a une.

Cet élément ne prend aucun paramètre.

Retour : error. Erreur de l'appel (une erreur typée du SDK), nil en cas de succès.

Erreurs levées : error.

SSEStream.Event

Event() SSEEvent

Event renvoie l'événement courant.

Cet élément ne prend aucun paramètre.

Retour : SSEEvent. Un SSEEvent : un événement Server-Sent Events.

SSEStream.Next

Next() bool

Next lit l'événement suivant ; false à la fin du flux ou sur une erreur (voir Err).

Cet élément ne prend aucun paramètre.

Retour : bool. true quand un nouvel événement est disponible via Event ; false après [DONE], à la fin du corps ou sur une erreur de lecture.

Fonctions

NewSSEStream

NewSSEStream(body io.ReadCloser) *SSEStream

NewSSEStream enveloppe le corps d'une réponse.

Nom	Type	Défaut	Requis	Description
body	io.ReadCloser		oui	Corps de la requête, sérialisé en JSON.

Retour : *SSEStream. Un SSEStream : il lit des Server-Sent Events ; "data: [DONE]" termine le flux. Toujours le fermer avec Close.