bahamut

Jan 21, 2023

Changes in this version

+ const CORSOriginMirror

+ type CORSPolicy struct

+ AllowCredentials bool

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigin string

+ ExposeHeaders []string

+ MaxAge int

+ func (a *CORSPolicy) Inject(h http.Header, origin string, preflight bool)

+ type CORSPolicyController interface

+ PolicyForRequest func(*http.Request) *CORSPolicy

+ func NewDefaultCORSController(origin string, additionalOrigins []string) CORSPolicyController

+ type MockContext struct

+ MockClaims []string

+ MockClaimsMap map[string]string

+ MockCount int

+ MockCtx context.Context

+ MockDisableOutputDataPush bool

+ MockEvents elemental.Events

+ MockID string

+ MockInputData interface{}

+ MockMessages []string

+ MockMetadata map[interface{}]interface{}

+ MockNext string

+ MockOutputCookies []*http.Cookie

+ MockOutputData interface{}

+ MockRedirect string

+ MockRequest *elemental.Request

+ MockResponseWriter ResponseWriter

+ MockStatusCode int

+ func NewMockContext(ctx context.Context) *MockContext

+ func (c *MockContext) AddMessage(msg string)

+ func (c *MockContext) AddOutputCookies(cookies ...*http.Cookie)

+ func (c *MockContext) Claims() []string

+ func (c *MockContext) ClaimsMap() map[string]string

+ func (c *MockContext) Context() context.Context

+ func (c *MockContext) Count() int

+ func (c *MockContext) Duplicate() Context

+ func (c *MockContext) EnqueueEvents(events ...*elemental.Event)

+ func (c *MockContext) Identifier() string

+ func (c *MockContext) InputData() interface{}

+ func (c *MockContext) Metadata(key interface{}) interface{}

+ func (c *MockContext) OutputData() interface{}

+ func (c *MockContext) Redirect() string

+ func (c *MockContext) Request() *elemental.Request

+ func (c *MockContext) SetClaims(claims []string)

+ func (c *MockContext) SetCount(count int)

+ func (c *MockContext) SetDisableOutputDataPush(disabled bool)

+ func (c *MockContext) SetInputData(data interface{})

+ func (c *MockContext) SetMetadata(key, value interface{})

+ func (c *MockContext) SetNext(next string)

+ func (c *MockContext) SetOutputData(data interface{})

+ func (c *MockContext) SetRedirect(url string)

+ func (c *MockContext) SetResponseWriter(writer ResponseWriter)

+ func (c *MockContext) SetStatusCode(code int)

+ func (c *MockContext) StatusCode() int

+ type MockSession struct

+ MockClaims []string

+ MockClaimsMap map[string]string

+ MockClientIP string

+ MockCookies map[string]*http.Cookie

+ MockDirectPush func(...*elemental.Event)

+ MockHeaders map[string]string

+ MockIdentifier string

+ MockMetadata interface{}

+ MockParameters map[string]string

+ MockPushConfig *elemental.PushConfig

+ MockTLSConnectionState *tls.ConnectionState

+ MockToken string

+ func NewMockSession() *MockSession

+ func (s *MockSession) Claims() []string

+ func (s *MockSession) ClaimsMap() map[string]string

+ func (s *MockSession) ClientIP() string

+ func (s *MockSession) Context() context.Context

+ func (s *MockSession) Cookie(c string) (*http.Cookie, error)

+ func (s *MockSession) DirectPush(evts ...*elemental.Event)

+ func (s *MockSession) Header(k string) string

+ func (s *MockSession) Identifier() string

+ func (s *MockSession) Metadata() interface{}

+ func (s *MockSession) Parameter(k string) string

+ func (s *MockSession) PushConfig() *elemental.PushConfig

+ func (s *MockSession) SetClaims(claims []string)

+ func (s *MockSession) SetMetadata(m interface{})

+ func (s *MockSession) TLSConnectionState() *tls.ConnectionState

+ func (s *MockSession) Token() string

type Option

+ func OptCORSAccessControl(controller CORSPolicyController) Option

+ func OptMTLSVerifyPeerCertificates(f func([][]byte, [][]*x509.Certificate) error) Option

Mar 23, 2021

Changes in this version

+ var ErrInvalidAPIVersion = elemental.NewError("Bad Request", fmt.Sprintf("Invalid api version number"), "bahamut", ...)

+ var ErrUnknownAPIVersion = elemental.NewError("Bad Request", fmt.Sprintf("Unknown api version"), "bahamut", ...)

+ func RegisterCustomHandlerOrDie(server Server, handler http.HandlerFunc, path string)

type Context

+ AddOutputCookies func(cookies ...*http.Cookie)

+ SetDisableOutputDataPush func(bool)

+ SetResponseWriter func(ResponseWriter)

type MetricsManager

+ RegisterTCPConnection func()

+ UnregisterTCPConnection func()

type NATSOption

+ func NATSErrorHandler(handler func(*nats.Conn, *nats.Subscription, error)) NATSOption

type Option

+ func OptAPIRateLimiting(identity elemental.Identity, limit float64, burst int, ...) Option

+ func OptEnableAPIPathPrefix(prefix string) Option

+ func OptEnableCustomRoutePathPrefix(prefix string) Option

+ func OptErrorTransformer(f func(error) error) Option

+ func OptHTTPLogger(l *log.Logger) Option

+ func OptMaxConnection(n int) Option

+ func OptPushServerEnableSubjectHierarchies() Option

+ func OptTLSDisableSessionTicket(disabled bool) Option

+ func OptTLSNextProtos(nextProtos []string) Option

+ type ResponseWriter func(w http.ResponseWriter) int

type Server

+ CustomHandlers func() map[string]http.HandlerFunc

+ RegisterCustomRouteHandler func(path string, handler http.HandlerFunc) error

+ UnregisterCustomRouteHandler func(path string) error

type Session

+ Cookie func(string) (*http.Cookie, error)

+ PushConfig func() *elemental.PushConfig

Oct 7, 2019

Changes in this version

type PushDispatchHandler

+ RelatedEventIdentities func(string) []string

+ SummarizeEvent func(event *elemental.Event) (interface{}, error)

Sep 30, 2019

Changes in this version

+ type IdentifiableRetriever func(*elemental.Request) (elemental.Identifiable, error)

type Option

+ func OptIdentifiableRetriever(f IdentifiableRetriever) Option

Sep 25, 2019

Changes in this version

type Context

+ SetNext func(string)

Jul 26, 2019

Changes in this version

type Session

+ ClientIP func() string

Jul 18, 2019

Changes in this version

+ type CustomMarshaller func(data interface{}) ([]byte, error)

type Option

+ func OptMarshallers(marshallers map[elemental.Identity]CustomMarshaller) Option

Jul 15, 2019

Changes in this version

type Option

+ func OptCORSOrigin(origin string) Option

Jun 17, 2019

Changes in this version

type PubSubOptSubscribe

+ func NATSOptSubscribeReplyTimeout(t time.Duration) PubSubOptSubscribe

type Publication

+ func (p *Publication) Reply(response *Publication) error

Jun 11, 2019

Changes in this version

type Publication

+ ResponseMode ResponseMode

+ type ResponseMode int

+ const ResponseModeACK

+ const ResponseModeNone

+ const ResponseModePublication

+ func (r ResponseMode) String() string

May 31, 2019

Changes in this version

type Option

+ func OptDisableCompression() Option

May 29, 2019

Changes in this version

type PubSubOptPublish

+ func NATSOptRespondToChannel(ctx context.Context, resp chan *Publication) PubSubOptPublish

May 21, 2019

Changes in this version

type NATSOption

+ func NATSOptConnectRetryInterval(interval time.Duration) NATSOption

May 1, 2019

Changes in this version

+ const PingStatusError

+ const PingStatusOK

+ const PingStatusTimeout

+ var ErrNotFound = elemental.NewError("Not Found", "Unable to find the requested resource", "bahamut", ...)

+ var ErrRateLimit = elemental.NewError("Rate Limit", "You have exceeded your rate limit", "bahamut", ...)

+ func CheckAuthentication(authenticators []RequestAuthenticator, ctx Context) (err error)

+ func CheckAuthorization(authorizers []Authorizer, ctx Context) (err error)

+ func InstallSIGINTHandler(cancelFunc context.CancelFunc)

+ func RegisterProcessorOrDie(server Server, processor Processor, identity elemental.Identity)

+ func RetrieveHealthStatus(timeout time.Duration, pingers map[string]Pinger) error

+ func RunJob(ctx context.Context, job Job) (bool, error)

+ type Auditer interface

+ Audit func(Context, error)

+ type AuthAction int

+ const AuthActionContinue

+ const AuthActionKO

+ const AuthActionOK

+ type Authorizer interface

+ IsAuthorized func(Context) (AuthAction, error)

+ type Context interface

+ AddMessage func(string)

+ Claims func() []string

+ ClaimsMap func() map[string]string

+ Context func() context.Context

+ Count func() int

+ Duplicate func() Context

+ EnqueueEvents func(...*elemental.Event)

+ Identifier func() string

+ InputData func() interface{}

+ Metadata func(key interface{}) interface{}

+ OutputData func() interface{}

+ Redirect func() string

+ Request func() *elemental.Request

+ SetClaims func(claims []string)

+ SetCount func(int)

+ SetInputData func(interface{})

+ SetMetadata func(key, value interface{})

+ SetOutputData func(interface{})

+ SetRedirect func(string)

+ SetStatusCode func(int)

+ StatusCode func() int

+ func NewContext(ctx context.Context, request *elemental.Request) Context

+ type CreateProcessor interface

+ ProcessCreate func(Context) error

+ type CustomUmarshaller func(*elemental.Request) (elemental.Identifiable, error)

+ type DeleteProcessor interface

+ ProcessDelete func(Context) error

+ type FinishMeasurementFunc func(code int, span opentracing.Span)

+ type HealthServerFunc func() error

+ type HealthStatFunc func(http.ResponseWriter, *http.Request)

+ type InfoProcessor interface

+ ProcessInfo func(Context) error

+ type Job func() error

+ type MetricsManager interface

+ MeasureRequest func(method string, url string) FinishMeasurementFunc

+ RegisterWSConnection func()

+ UnregisterWSConnection func()

+ Write func(w http.ResponseWriter, r *http.Request)

+ func NewPrometheusMetricsManager() MetricsManager

+ type NATSOption func(*natsPubSub)

+ func NATSOptClientID(clientID string) NATSOption

+ func NATSOptClusterID(clusterID string) NATSOption

+ func NATSOptCredentials(username string, password string) NATSOption

+ func NATSOptTLS(tlsConfig *tls.Config) NATSOption

+ type Option func(*config)

+ func OptAuditer(auditer Auditer) Option

+ func OptAuthenticators(requestAuthenticators []RequestAuthenticator, ...) Option

+ func OptAuthorizers(authorizers []Authorizer) Option

+ func OptCustomListener(listener net.Listener) Option

+ func OptCustomRootHandler(handler http.HandlerFunc) Option

+ func OptDisableKeepAlive() Option

+ func OptDisableMetaRoutes() Option

+ func OptDisablePanicRecovery() Option

+ func OptHealthCustomStats(handlers map[string]HealthStatFunc) Option

+ func OptHealthServer(listen string, handler HealthServerFunc) Option

+ func OptHealthServerMetricsManager(manager MetricsManager) Option

+ func OptHealthServerTimeouts(read, write, idle time.Duration) Option

+ func OptMTLS(caPool *x509.CertPool, authType tls.ClientAuthType) Option

+ func OptModel(modelManagers map[int]elemental.ModelManager) Option

+ func OptOpentracingExcludedIdentities(identities []elemental.Identity) Option

+ func OptOpentracingTracer(tracer opentracing.Tracer) Option

+ func OptPostStartHook(hook func(Server) error) Option

+ func OptPreStopHook(hook func(Server) error) Option

+ func OptProfilingGCP(projectID string, servicePrefix string) Option

+ func OptProfilingLocal(listen string) Option

+ func OptPushDispatchHandler(dispatchHandler PushDispatchHandler) Option

+ func OptPushEndpoint(endpoint string) Option

+ func OptPushPublishHandler(publishHandler PushPublishHandler) Option

+ func OptPushServer(service PubSubClient, topic string) Option

+ func OptRateLimiting(limit float64, burst int) Option

+ func OptReadOnly(excluded []elemental.Identity) Option

+ func OptRestServer(listen string) Option

+ func OptServiceInfo(name string, version string, subversions map[string]interface{}) Option

+ func OptTLS(certs []tls.Certificate, ...) Option

+ func OptTimeouts(read, write, idle time.Duration) Option

+ func OptTraceCleaner(cleaner TraceCleaner) Option

+ func OptUnmarshallers(unmarshallers map[elemental.Identity]CustomUmarshaller) Option

+ type PatchProcessor interface

+ ProcessPatch func(Context) error

+ type Pinger interface

+ Ping func(timeout time.Duration) error

+ type Processor interface

+ type PubSubClient interface

+ Connect func() Waiter

+ Disconnect func() error

+ Publish func(publication *Publication, opts ...PubSubOptPublish) error

+ Subscribe func(pubs chan *Publication, errors chan error, topic string, ...) func()

+ func NewLocalPubSubClient() PubSubClient

+ func NewNATSPubSubClient(natsURL string, options ...NATSOption) PubSubClient

+ type PubSubOptPublish func(interface{})

+ func NATSOptPublishReplyValidator(ctx context.Context, validator func(msg *nats.Msg) error) PubSubOptPublish

+ func NATSOptPublishRequireAck(ctx context.Context) PubSubOptPublish

+ type PubSubOptSubscribe func(interface{})

+ func NATSOptSubscribeQueue(queueGroup string) PubSubOptSubscribe

+ func NATSOptSubscribeReplyer(replier func(msg *nats.Msg) []byte) PubSubOptSubscribe

+ type Publication struct

+ Data []byte

+ Encoding elemental.EncodingType

+ Partition int32

+ Topic string

+ TrackingData opentracing.TextMapCarrier

+ TrackingName string

+ func NewPublication(topic string) *Publication

+ func (p *Publication) Decode(dest interface{}) error

+ func (p *Publication) Duplicate() *Publication

+ func (p *Publication) Encode(o interface{}) error

+ func (p *Publication) EncodeWithEncoding(o interface{}, encoding elemental.EncodingType) error

+ func (p *Publication) Span() opentracing.Span

+ func (p *Publication) StartTracing(tracer opentracing.Tracer, name string)

+ func (p *Publication) StartTracingFromSpan(span opentracing.Span, name string) error

+ type PushDispatchHandler interface

+ OnPushSessionInit func(PushSession) (bool, error)

+ OnPushSessionStart func(PushSession)

+ OnPushSessionStop func(PushSession)

+ ShouldDispatch func(PushSession, *elemental.Event) (bool, error)

+ type PushPublishHandler interface

+ ShouldPublish func(*elemental.Event) (bool, error)

+ type PushSession interface

+ DirectPush func(...*elemental.Event)

+ type RateLimiter interface

+ RateLimit func(*http.Request) (bool, error)

+ type RequestAuthenticator interface

+ AuthenticateRequest func(Context) (AuthAction, error)

+ type RetrieveManyProcessor interface

+ ProcessRetrieveMany func(Context) error

+ type RetrieveProcessor interface

+ ProcessRetrieve func(Context) error

+ type RouteInfo struct

+ Identity string

+ Private bool

+ URL string

+ Verbs []string

+ func (r RouteInfo) String() string

+ type Server interface

+ ProcessorForIdentity func(elemental.Identity) (Processor, error)

+ ProcessorsCount func() int

+ Push func(...*elemental.Event)

+ PushEndpoint func() string

+ RegisterProcessor func(Processor, elemental.Identity) error

+ RoutesInfo func() map[int][]RouteInfo

+ Run func(context.Context)

+ UnregisterProcessor func(elemental.Identity) error

+ VersionsInfo func() map[string]interface{}

+ func New(options ...Option) Server

+ func NewServer(cfg config) Server

+ type Session interface

+ Claims func() []string

+ ClaimsMap func() map[string]string

+ Context func() context.Context

+ Header func(string) string

+ Identifier func() string

+ Metadata func() interface{}

+ Parameter func(string) string

+ SetClaims func([]string)

+ SetMetadata func(interface{})

+ TLSConnectionState func() *tls.ConnectionState

+ Token func() string

+ type SessionAuthenticator interface

+ AuthenticateSession func(Session) (AuthAction, error)

+ type TraceCleaner func(elemental.Identity, []byte) []byte

+ type UpdateProcessor interface

+ ProcessUpdate func(Context) error

+ type Waiter interface

+ Wait func(time.Duration) bool