rta

type Conn ¶

type Conn struct {
	// contains filtered or unexported fields
}

Conn represents a connection between the real-time activity services. It can be established from Dialer with an authorization token that relies on the party 'https://xboxlive.com/'.

A Conn controls subscriptions real-timely under a websocket connection. An index-specific JSON array is used for the communication. Conn is safe for concurrent use in multiple goroutines.

SubscriptionHandlers are useful to handle any events that may occur in the subscriptions controlled by Conn, and can be stored atomically to a Subscription from Subscription.Handle.

func (c *Conn) Close() (err error)

func (c *Conn) Subscribe(ctx context.Context, resourceURI string) (*Subscription, error)

func (c *Conn) Unsubscribe(ctx context.Context, sub *Subscription) error

type Dialer ¶

type Dialer struct {
	Options  *websocket.DialOptions
	ErrorLog *slog.Logger
}

Dialer represents the options for establishing a Conn with real-time activity services with DialContext or Dial.

func (d Dialer) Dial(src xsapi.TokenSource) (*Conn, error)

func (d Dialer) DialContext(ctx context.Context, src xsapi.TokenSource) (*Conn, error)

type NopSubscriptionHandler ¶

type NopSubscriptionHandler struct{}

func (NopSubscriptionHandler) HandleEvent(json.RawMessage)

type OutOfRangeError ¶

type OutOfRangeError struct {
	Payload []json.RawMessage
	Index   int
}

An OutOfRangeError occurs when reading values from payload received from the service. The Payload specifies the remaining values included in the payload, and the Index specifies a length of values that is missing from the payload.

func (e *OutOfRangeError) Error() string

type Subscription ¶

type Subscription struct {
	ID     uint32
	Custom json.RawMessage
	// contains filtered or unexported fields
}

Subscription represents a subscription contracted with the resource URI available through the real-time activity service. A Subscription may be contracted via Conn.Subscribe.

func (s *Subscription) Handle(h SubscriptionHandler)

type SubscriptionHandler ¶

type SubscriptionHandler interface {
	HandleEvent(custom json.RawMessage)
}

type UnexpectedStatusError ¶

type UnexpectedStatusError struct {
	Code    int32
	Message string
}

func (e *UnexpectedStatusError) Error() string