soundboardconnect

Documentation

Index

• Constants
• func NewSoundboardHandler(svc SoundboardHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type SoundboardClient
  • func NewSoundboardClient(httpClient connect_go.HTTPClient, baseURL string, ...) SoundboardClient
• type SoundboardHandler
• type UnimplementedSoundboardHandler
  • func (UnimplementedSoundboardHandler) CreateSoundboard(context.Context, *connect_go.Request[soundboard.CreateSoundboardReq]) (*connect_go.Response[soundboard.CreateSoundboardRes], error)
  • func (UnimplementedSoundboardHandler) DeleteSoundboard(context.Context, *connect_go.Request[soundboard.DeleteSoundboardReq]) (*connect_go.Response[soundboard.DeleteSoundboardRes], error)
  • func (UnimplementedSoundboardHandler) GetSoundboardFile(context.Context, *connect_go.Request[soundboard.GetSoundboardFileReq], ...) error
  • func (UnimplementedSoundboardHandler) ListSoundboards(context.Context, *connect_go.Request[soundboard.ListSoundboardsReq]) (*connect_go.Response[soundboard.ListSoundboardsRes], error)
  • func (UnimplementedSoundboardHandler) UpdateSoundboard(context.Context, *connect_go.Request[soundboard.UpdateSoundboardReq]) (*connect_go.Response[soundboard.UpdateSoundboardRes], error)

Constants

const (
	// SoundboardGetSoundboardFileProcedure is the fully-qualified name of the Soundboard's
	// GetSoundboardFile RPC.
	SoundboardGetSoundboardFileProcedure = "/api.v1alpha1.soundboard.Soundboard/GetSoundboardFile"
	// SoundboardCreateSoundboardProcedure is the fully-qualified name of the Soundboard's
	// CreateSoundboard RPC.
	SoundboardCreateSoundboardProcedure = "/api.v1alpha1.soundboard.Soundboard/CreateSoundboard"
	// SoundboardListSoundboardsProcedure is the fully-qualified name of the Soundboard's
	// ListSoundboards RPC.
	SoundboardListSoundboardsProcedure = "/api.v1alpha1.soundboard.Soundboard/ListSoundboards"
	// SoundboardUpdateSoundboardProcedure is the fully-qualified name of the Soundboard's
	// UpdateSoundboard RPC.
	SoundboardUpdateSoundboardProcedure = "/api.v1alpha1.soundboard.Soundboard/UpdateSoundboard"
	// SoundboardDeleteSoundboardProcedure is the fully-qualified name of the Soundboard's
	// DeleteSoundboard RPC.
	SoundboardDeleteSoundboardProcedure = "/api.v1alpha1.soundboard.Soundboard/DeleteSoundboard"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

const (
	// SoundboardName is the fully-qualified name of the Soundboard service.
	SoundboardName = "api.v1alpha1.soundboard.Soundboard"
)

Functions

func NewSoundboardHandler

func NewSoundboardHandler(svc SoundboardHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewSoundboardHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type SoundboardClient

type SoundboardClient interface {
	// GetSoundboardFile streams back segments of the audio file stored in rec
	// corresponding to the provided soundboard id and org id.
	GetSoundboardFile(context.Context, *connect_go.Request[soundboard.GetSoundboardFileReq]) (*connect_go.ServerStreamForClient[soundboard.GetSoundboardFileRes], error)
	// CreateSoundboard takes in a stream of metadata and audio file segments.
	// The first expected message should contain SoundboardDetails, then following
	// messages will be chunks of audio file data, which is then aggregated and put
	// into rec. The generated soundboard id is returned.
	CreateSoundboard(context.Context, *connect_go.Request[soundboard.CreateSoundboardReq]) (*connect_go.Response[soundboard.CreateSoundboardRes], error)
	// ListSoundboards returns all of the metadata for soundboards corresponding
	// corresponding to a given org id.
	ListSoundboards(context.Context, *connect_go.Request[soundboard.ListSoundboardsReq]) (*connect_go.Response[soundboard.ListSoundboardsRes], error)
	// UpdateSondboard updates a soundboard's metadata in the soundboard table.
	UpdateSoundboard(context.Context, *connect_go.Request[soundboard.UpdateSoundboardReq]) (*connect_go.Response[soundboard.UpdateSoundboardRes], error)
	// DeleteSondboard deletes a soundboard's metadata from the soundboard table.
	DeleteSoundboard(context.Context, *connect_go.Request[soundboard.DeleteSoundboardReq]) (*connect_go.Response[soundboard.DeleteSoundboardRes], error)
}

SoundboardClient is a client for the api.v1alpha1.soundboard.Soundboard service.

func NewSoundboardClient

func NewSoundboardClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) SoundboardClient

NewSoundboardClient constructs a client for the api.v1alpha1.soundboard.Soundboard service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type SoundboardHandler

type SoundboardHandler interface {
	// GetSoundboardFile streams back segments of the audio file stored in rec
	// corresponding to the provided soundboard id and org id.
	GetSoundboardFile(context.Context, *connect_go.Request[soundboard.GetSoundboardFileReq], *connect_go.ServerStream[soundboard.GetSoundboardFileRes]) error
	// CreateSoundboard takes in a stream of metadata and audio file segments.
	// The first expected message should contain SoundboardDetails, then following
	// messages will be chunks of audio file data, which is then aggregated and put
	// into rec. The generated soundboard id is returned.
	CreateSoundboard(context.Context, *connect_go.Request[soundboard.CreateSoundboardReq]) (*connect_go.Response[soundboard.CreateSoundboardRes], error)
	// ListSoundboards returns all of the metadata for soundboards corresponding
	// corresponding to a given org id.
	ListSoundboards(context.Context, *connect_go.Request[soundboard.ListSoundboardsReq]) (*connect_go.Response[soundboard.ListSoundboardsRes], error)
	// UpdateSondboard updates a soundboard's metadata in the soundboard table.
	UpdateSoundboard(context.Context, *connect_go.Request[soundboard.UpdateSoundboardReq]) (*connect_go.Response[soundboard.UpdateSoundboardRes], error)
	// DeleteSondboard deletes a soundboard's metadata from the soundboard table.
	DeleteSoundboard(context.Context, *connect_go.Request[soundboard.DeleteSoundboardReq]) (*connect_go.Response[soundboard.DeleteSoundboardRes], error)
}

SoundboardHandler is an implementation of the api.v1alpha1.soundboard.Soundboard service.

type UnimplementedSoundboardHandler

type UnimplementedSoundboardHandler struct{}

UnimplementedSoundboardHandler returns CodeUnimplemented from all methods.

func (UnimplementedSoundboardHandler) CreateSoundboard

func (UnimplementedSoundboardHandler) CreateSoundboard(context.Context, *connect_go.Request[soundboard.CreateSoundboardReq]) (*connect_go.Response[soundboard.CreateSoundboardRes], error)

func (UnimplementedSoundboardHandler) DeleteSoundboard

func (UnimplementedSoundboardHandler) DeleteSoundboard(context.Context, *connect_go.Request[soundboard.DeleteSoundboardReq]) (*connect_go.Response[soundboard.DeleteSoundboardRes], error)

func (UnimplementedSoundboardHandler) GetSoundboardFile

func (UnimplementedSoundboardHandler) GetSoundboardFile(context.Context, *connect_go.Request[soundboard.GetSoundboardFileReq], *connect_go.ServerStream[soundboard.GetSoundboardFileRes]) error

func (UnimplementedSoundboardHandler) ListSoundboards

func (UnimplementedSoundboardHandler) ListSoundboards(context.Context, *connect_go.Request[soundboard.ListSoundboardsReq]) (*connect_go.Response[soundboard.ListSoundboardsRes], error)

func (UnimplementedSoundboardHandler) UpdateSoundboard

func (UnimplementedSoundboardHandler) UpdateSoundboard(context.Context, *connect_go.Request[soundboard.UpdateSoundboardReq]) (*connect_go.Response[soundboard.UpdateSoundboardRes], error)