api

module
v4.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 20, 2024 License: MIT

README

RoadRunner API

To install and use generated packages:

go get github.com/roadrunner-server/api/v4/build/<API_NAME>/v1

The Proto API is used for external integrations, mostly for RPC or as internal communications. For example:

package foo

import (
	jobsv1 "github.com/roadrunner-server/api/v4/build/jobs/v1"
)

func Push(in *jobsv1.PushRequest, out *jobsv1.Empty) error {
	return nil
}

Centrifugal API

Building API

  • Install buf: go install github.com/bufbuild/buf/cmd/buf@latest.
  • In the repository root run: buf generate --debug

Jump to

Keyboard shortcuts

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