lmsconnect

Documentation

Index

• Constants
• func NewLMSHandler(svc LMSHandler, opts ...connect_go.HandlerOption) (string, http.Handler)
• type LMSClient
  • func NewLMSClient(httpClient connect_go.HTTPClient, baseURL string, ...) LMSClient
• type LMSHandler
• type UnimplementedLMSHandler
  • func (UnimplementedLMSHandler) DeleteFileTemplate(context.Context, *connect_go.Request[lms.DeleteFileTemplateRequest]) (*connect_go.Response[lms.DeleteFileTemplateResponse], error)
  • func (UnimplementedLMSHandler) GetFileTemplate(context.Context, *connect_go.Request[lms.GetFileTemplateRequest]) (*connect_go.Response[lms.GetFileTemplateResponse], error)
  • func (UnimplementedLMSHandler) ListFileTemplates(context.Context, *connect_go.Request[lms.ListFileTemplatesRequest]) (*connect_go.Response[lms.ListFileTemplatesResponse], error)
  • func (UnimplementedLMSHandler) ParseFileTemplate(context.Context, *connect_go.Request[lms.ParseFileTemplateRequest]) (*connect_go.Response[lms.ParseFileTemplateResult], error)
  • func (UnimplementedLMSHandler) UpdateFileTemplate(context.Context, *connect_go.Request[lms.UpdateFileTemplateRequest]) (*connect_go.Response[lms.UpdateFileTemplateResponse], error)

Constants

const (
	// LMSDeleteFileTemplateProcedure is the fully-qualified name of the LMS's DeleteFileTemplate RPC.
	LMSDeleteFileTemplateProcedure = "/api.v1alpha1.lms.LMS/DeleteFileTemplate"
	// LMSGetFileTemplateProcedure is the fully-qualified name of the LMS's GetFileTemplate RPC.
	LMSGetFileTemplateProcedure = "/api.v1alpha1.lms.LMS/GetFileTemplate"
	// LMSListFileTemplatesProcedure is the fully-qualified name of the LMS's ListFileTemplates RPC.
	LMSListFileTemplatesProcedure = "/api.v1alpha1.lms.LMS/ListFileTemplates"
	// LMSParseFileTemplateProcedure is the fully-qualified name of the LMS's ParseFileTemplate RPC.
	LMSParseFileTemplateProcedure = "/api.v1alpha1.lms.LMS/ParseFileTemplate"
	// LMSUpdateFileTemplateProcedure is the fully-qualified name of the LMS's UpdateFileTemplate RPC.
	LMSUpdateFileTemplateProcedure = "/api.v1alpha1.lms.LMS/UpdateFileTemplate"
)

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 (
	// LMSName is the fully-qualified name of the LMS service.
	LMSName = "api.v1alpha1.lms.LMS"
)

Functions

func NewLMSHandler

func NewLMSHandler(svc LMSHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewLMSHandler 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 LMSClient

type LMSClient interface {
	DeleteFileTemplate(context.Context, *connect_go.Request[lms.DeleteFileTemplateRequest]) (*connect_go.Response[lms.DeleteFileTemplateResponse], error)
	GetFileTemplate(context.Context, *connect_go.Request[lms.GetFileTemplateRequest]) (*connect_go.Response[lms.GetFileTemplateResponse], error)
	ListFileTemplates(context.Context, *connect_go.Request[lms.ListFileTemplatesRequest]) (*connect_go.Response[lms.ListFileTemplatesResponse], error)
	ParseFileTemplate(context.Context, *connect_go.Request[lms.ParseFileTemplateRequest]) (*connect_go.Response[lms.ParseFileTemplateResult], error)
	UpdateFileTemplate(context.Context, *connect_go.Request[lms.UpdateFileTemplateRequest]) (*connect_go.Response[lms.UpdateFileTemplateResponse], error)
}

LMSClient is a client for the api.v1alpha1.lms.LMS service.

func NewLMSClient

func NewLMSClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) LMSClient

NewLMSClient constructs a client for the api.v1alpha1.lms.LMS 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 LMSHandler

type LMSHandler interface {
	DeleteFileTemplate(context.Context, *connect_go.Request[lms.DeleteFileTemplateRequest]) (*connect_go.Response[lms.DeleteFileTemplateResponse], error)
	GetFileTemplate(context.Context, *connect_go.Request[lms.GetFileTemplateRequest]) (*connect_go.Response[lms.GetFileTemplateResponse], error)
	ListFileTemplates(context.Context, *connect_go.Request[lms.ListFileTemplatesRequest]) (*connect_go.Response[lms.ListFileTemplatesResponse], error)
	ParseFileTemplate(context.Context, *connect_go.Request[lms.ParseFileTemplateRequest]) (*connect_go.Response[lms.ParseFileTemplateResult], error)
	UpdateFileTemplate(context.Context, *connect_go.Request[lms.UpdateFileTemplateRequest]) (*connect_go.Response[lms.UpdateFileTemplateResponse], error)
}

LMSHandler is an implementation of the api.v1alpha1.lms.LMS service.

type UnimplementedLMSHandler

type UnimplementedLMSHandler struct{}

UnimplementedLMSHandler returns CodeUnimplemented from all methods.

func (UnimplementedLMSHandler) DeleteFileTemplate

func (UnimplementedLMSHandler) DeleteFileTemplate(context.Context, *connect_go.Request[lms.DeleteFileTemplateRequest]) (*connect_go.Response[lms.DeleteFileTemplateResponse], error)

func (UnimplementedLMSHandler) GetFileTemplate

func (UnimplementedLMSHandler) GetFileTemplate(context.Context, *connect_go.Request[lms.GetFileTemplateRequest]) (*connect_go.Response[lms.GetFileTemplateResponse], error)

func (UnimplementedLMSHandler) ListFileTemplates

func (UnimplementedLMSHandler) ListFileTemplates(context.Context, *connect_go.Request[lms.ListFileTemplatesRequest]) (*connect_go.Response[lms.ListFileTemplatesResponse], error)

func (UnimplementedLMSHandler) ParseFileTemplate

func (UnimplementedLMSHandler) ParseFileTemplate(context.Context, *connect_go.Request[lms.ParseFileTemplateRequest]) (*connect_go.Response[lms.ParseFileTemplateResult], error)

func (UnimplementedLMSHandler) UpdateFileTemplate

func (UnimplementedLMSHandler) UpdateFileTemplate(context.Context, *connect_go.Request[lms.UpdateFileTemplateRequest]) (*connect_go.Response[lms.UpdateFileTemplateResponse], error)