module

package
v0.0.0-...-69e9717 Latest Latest
Warning

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

Go to latest
Published: Feb 13, 2026 License: MIT Imports: 8 Imported by: 0

README

GoStratifyServer-SDK

DigiStratum Stratify SaaS Platform Developer SDK - Library - Module

Import this package into custom Module and Endpoint implementations. See documentation/notes within each source file for additional information.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewEndpointInfo

func NewEndpointInfo(name, version string) *endpointInfo

Make a new one of these

Types

type AnyEndpointIfc

type AnyEndpointIfc interface {
	HandleAny(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: ANY METHOD request handling

type DeleteEndpointIfc

type DeleteEndpointIfc interface {
	HandleDelete(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: DELETE request handling

type Endpoint

type Endpoint struct {
	// Embedded struct(s)
	*cfg.Configurable
	*dep.DependencyInjectable
	*startable.Startable
	// contains filtered or unexported fields
}

Exported to support embedding

func NewEndpoint

func NewEndpoint(name, version string) *Endpoint

func (*Endpoint) Configure

func (r *Endpoint) Configure(config cfg.ConfigIfc) error

func (*Endpoint) GetInfo

func (r *Endpoint) GetInfo() *endpointInfo

func (*Endpoint) IsStarted

func (r *Endpoint) IsStarted() bool

func (*Endpoint) Start

func (r *Endpoint) Start() error

type EndpointIfc

type EndpointIfc interface {
	// Embedded interface(s)
	cfg.ConfigurableIfc
	dep.DependencyInjectableIfc
	startable.StartableIfc

	// Our own interface
	GetInfo() *endpointInfo
}

Required: Endpoint public interface

type EndpointInfoIfc

type EndpointInfoIfc interface {
	GetName() string
	GetVersion() string
	GetId() string
}

EndpointInfo public interface

type GetEndpointIfc

type GetEndpointIfc interface {
	HandleGet(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: GET request handling

type HeadEndpointIfc

type HeadEndpointIfc interface {
	HandleHead(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: HEAD request handling

type Module

type Module struct {
	// Embedded struct(s)
	*cfg.Configurable
	*dep.DependencyInjectable
	*startable.Startable
	// contains filtered or unexported fields
}

Exported to support embedding

func NewModule

func NewModule(moduleName string, endpoints ...EndpointIfc) *Module

func (*Module) Configure

func (r *Module) Configure(serverConfig cfg.ConfigIfc) error

func (*Module) GetEndpoints

func (r *Module) GetEndpoints() []EndpointIfc

ModuleWrapper wants our endpoints

func (*Module) GetName

func (r *Module) GetName() string

ModuleWrapper wants our Name

func (*Module) InjectDependencies

func (r *Module) InjectDependencies(depinst ...dep.DependencyInstanceIfc) error

func (*Module) Start

func (r *Module) Start() error

type ModuleIfc

type ModuleIfc interface {
	// Embedded Interface(s)
	cfg.ConfigurableIfc
	dep.DependencyInjectableIfc
	startable.StartableIfc

	// Our own interface
	GetName() string
	GetEndpoints() []EndpointIfc
}

type OptionsEndpointIfc

type OptionsEndpointIfc interface {
	HandleOptions(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: OPTIONS request handling

type PatchEndpointIfc

type PatchEndpointIfc interface {
	HandlePatch(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: PATCH request handling

type PostEndpointIfc

type PostEndpointIfc interface {
	HandlePost(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: POST request handling

type PutEndpointIfc

type PutEndpointIfc interface {
	HandlePut(request http.HttpRequestIfc) http.HttpResponseIfc
}

Optional: Endpoint public interface: PUT request handling

Jump to

Keyboard shortcuts

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