api

package

v1.3.99 Latest Latest Go to latest Published: Oct 4, 2026 License: AGPL-3.0 Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/skycoin/skywire

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api pkg/deployment/rf/api/api.go c2-net-routing

Index ¶

type API
- func New(s store.Store, logger logrus.FieldLogger, enableMetrics bool, dmsgAddr string) *API
- func (a *API) ShareTransportsFrom(url string)
- func (a *API) StartGraphCache(ctx context.Context)
type HealthCheckResponse

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type API ¶

type API struct {
	http.Handler

	DmsgServers []string
	// contains filtered or unexported fields
}

API represents the api of the route-finder service.

func New ¶

func New(s store.Store, logger logrus.FieldLogger, enableMetrics bool, dmsgAddr string) *API

New creates a new api

func (*API) ShareTransportsFrom ¶ added in v1.3.99

func (a *API) ShareTransportsFrom(url string)

ShareTransportsFrom builds the route graph from the live transport set of a TPD in this process writing to the redis at url, when there is one (see GraphCache.ShareFrom). Call before StartGraphCache.

func (*API) StartGraphCache ¶

func (a *API) StartGraphCache(ctx context.Context)

StartGraphCache keeps one shared full-network graph warm in the background so route requests no longer each build a per-source graph by walking the store. Bound to ctx (the server lifecycle); until the first build lands, requests fall back to the per-source build. Call once at server start.

type HealthCheckResponse ¶

type HealthCheckResponse = httputil.HealthCheckResponse

HealthCheckResponse is the /health body every service shares.

Source Files ¶

View all Source files

api.go

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