api

package

v0.0.6 Latest Latest Go to latest Published: Apr 17, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/streamdal/streamdal

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	AuthTokenMetadata = "auth-token"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

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

func New ¶

func New(opts *Options) (*API, error)

func (*API) GetAllLiveAudiences ¶

func (a *API) GetAllLiveAudiences(ctx context.Context) ([]*protos.Audience, error)

GetAllLiveAudiences returns all live audiences -- clients that are actively connected to the streamdal server and have announced one or more audiences)

func (*API) Tail ¶

func (a *API) Tail(ctx context.Context, audience *protos.Audience) (chan *protos.TailResponse, error)

func (*API) Test ¶

func (a *API) Test(ctx context.Context) error

Test performs a test connect to the gRPC API. We use this method to verify that we are able to talk to the gRPC server.

type Options ¶

type Options struct {
	Address        string
	AuthToken      string
	ConnectTimeout time.Duration
	DisableTLS     bool
}

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL