client

package

v4.1.20 Latest Latest Go to latest Published: Oct 9, 2025 License: GPL-2.0 Imports: 17 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	*client.DefaultClient
}

Client denotes a global query client

func New(addr string, opts ...client.Option) *Client

New creates a new client for the global-query API

func (c *Client) Query(ctx context.Context, args *query.Args) (*results.Result, error)

Query performs the global query and returns its result

func (c *Client) Run(ctx context.Context, args *query.Args) (*results.Result, error)

Run implements the query.Runner interface

type SSEClient struct {
	*client.DefaultClient
	// contains filtered or unexported fields
}

SSEClient is a global query client capable of streaming updates

func NewSSE(addr string, onUpdate, onFinish StreamingUpdate, onKeepalive StreamingKeepalive, opts ...client.Option) *SSEClient

NewSSE creates a new streaming client for the global-query API

func NewSSEFromConfig(cfg *gpclient.Config, keepaliveChan chan<- struct{}) *SSEClient

NewFromConfig creates the client based on cfg, sending keepalive signals on the provided channel

func (sse *SSEClient) Query(ctx context.Context, args *query.Args) (*results.Result, error)

Query performs the global query and returns its result, while consuming updates to partial results

func (sse *SSEClient) Run(ctx context.Context, args *query.Args) (*results.Result, error)

Run implements the query.Runner interface

type StreamingKeepalive func(context.Context) error

StreamingKeepalive is a function which operates on a received keepalive

type StreamingUpdate func(context.Context, *results.Result) error

StreamingUpdate is a function which operates on a received result