api

Documentation

Index

• type BFFService
• type Config
• type GeneralRateLimits
• type GroupRateLimits
• type MockBFFService
  • func NewMockBFFService(t interface{ ... }) *MockBFFService
  • func (_m *MockBFFService) EXPECT() *MockBFFService_Expecter
  • func (_m *MockBFFService) PassThrough(clientConn wasabi.Connection, req *request.Request) error
  • func (_m *MockBFFService) ProcessRequest(clientConn wasabi.Connection, req *request.Request) error
• type MockBFFService_Expecter
  • func (_e *MockBFFService_Expecter) PassThrough(clientConn interface{}, req interface{}) *MockBFFService_PassThrough_Call
  • func (_e *MockBFFService_Expecter) ProcessRequest(clientConn interface{}, req interface{}) *MockBFFService_ProcessRequest_Call
• type MockBFFService_PassThrough_Call
  • func (_c *MockBFFService_PassThrough_Call) Return(_a0 error) *MockBFFService_PassThrough_Call
  • func (_c *MockBFFService_PassThrough_Call) Run(run func(clientConn wasabi.Connection, req *request.Request)) *MockBFFService_PassThrough_Call
  • func (_c *MockBFFService_PassThrough_Call) RunAndReturn(run func(wasabi.Connection, *request.Request) error) *MockBFFService_PassThrough_Call
• type MockBFFService_ProcessRequest_Call
  • func (_c *MockBFFService_ProcessRequest_Call) Return(_a0 error) *MockBFFService_ProcessRequest_Call
  • func (_c *MockBFFService_ProcessRequest_Call) Run(run func(clientConn wasabi.Connection, req *request.Request)) *MockBFFService_ProcessRequest_Call
  • func (_c *MockBFFService_ProcessRequest_Call) RunAndReturn(run func(wasabi.Connection, *request.Request) error) *MockBFFService_ProcessRequest_Call
• type RateLimits
• type Service
  • func NewSevice(cfg *Config, handler BFFService) (*Service, error)
  • func (s *Service) Addr() net.Addr
  • func (s *Service) Handle(conn wasabi.Connection, r wasabi.Request) error
  • func (s *Service) HealthCheck(w http.ResponseWriter, _ *http.Request)
  • func (s *Service) Run(ctx context.Context) error

Types

type BFFService

type BFFService interface {
	PassThrough(clientConn wasabi.Connection, req *request.Request) error
	ProcessRequest(clientConn wasabi.Connection, req *request.Request) error
}

type Config

type Config struct {
	Listen             string     `mapstructure:"listen"`
	RateLimits         RateLimits `mapstructure:"rate_limits"`
	MaxRequests        uint       `mapstructure:"max_requests"`
	MaxRequestsPerConn uint       `mapstructure:"max_requests_per_conn"`
}

type GeneralRateLimits

type GeneralRateLimits struct {
	Interval string `mapstructure:"interval"`
	Limit    uint   `mapstructure:"limit"`
}

type GroupRateLimits

type GroupRateLimits struct {
	Name    string            `mapstructure:"name"`
	Limits  GeneralRateLimits `mapstructure:"limits"`
	Methods []string          `mapstructure:"methods"`
}

type MockBFFService

type MockBFFService struct {
	mock.Mock
}

MockBFFService is an autogenerated mock type for the BFFService type

func NewMockBFFService

func NewMockBFFService(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockBFFService

NewMockBFFService creates a new instance of MockBFFService. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockBFFService) EXPECT

func (_m *MockBFFService) EXPECT() *MockBFFService_Expecter

func (*MockBFFService) PassThrough

func (_m *MockBFFService) PassThrough(clientConn wasabi.Connection, req *request.Request) error

PassThrough provides a mock function with given fields: clientConn, req

func (*MockBFFService) ProcessRequest

func (_m *MockBFFService) ProcessRequest(clientConn wasabi.Connection, req *request.Request) error

ProcessRequest provides a mock function with given fields: clientConn, req

type MockBFFService_Expecter

type MockBFFService_Expecter struct {
	// contains filtered or unexported fields
}

func (*MockBFFService_Expecter) PassThrough

func (_e *MockBFFService_Expecter) PassThrough(clientConn interface{}, req interface{}) *MockBFFService_PassThrough_Call

PassThrough is a helper method to define mock.On call

• clientConn wasabi.Connection
• req *request.Request

func (*MockBFFService_Expecter) ProcessRequest

func (_e *MockBFFService_Expecter) ProcessRequest(clientConn interface{}, req interface{}) *MockBFFService_ProcessRequest_Call

ProcessRequest is a helper method to define mock.On call

• clientConn wasabi.Connection
• req *request.Request

type MockBFFService_PassThrough_Call

type MockBFFService_PassThrough_Call struct {
	*mock.Call
}

MockBFFService_PassThrough_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'PassThrough'

func (*MockBFFService_PassThrough_Call) Return

func (_c *MockBFFService_PassThrough_Call) Return(_a0 error) *MockBFFService_PassThrough_Call

func (*MockBFFService_PassThrough_Call) Run

func (_c *MockBFFService_PassThrough_Call) Run(run func(clientConn wasabi.Connection, req *request.Request)) *MockBFFService_PassThrough_Call

func (*MockBFFService_PassThrough_Call) RunAndReturn

func (_c *MockBFFService_PassThrough_Call) RunAndReturn(run func(wasabi.Connection, *request.Request) error) *MockBFFService_PassThrough_Call

type MockBFFService_ProcessRequest_Call

type MockBFFService_ProcessRequest_Call struct {
	*mock.Call
}

MockBFFService_ProcessRequest_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ProcessRequest'

func (*MockBFFService_ProcessRequest_Call) Return

func (_c *MockBFFService_ProcessRequest_Call) Return(_a0 error) *MockBFFService_ProcessRequest_Call

func (*MockBFFService_ProcessRequest_Call) Run

func (_c *MockBFFService_ProcessRequest_Call) Run(run func(clientConn wasabi.Connection, req *request.Request)) *MockBFFService_ProcessRequest_Call

func (*MockBFFService_ProcessRequest_Call) RunAndReturn

func (_c *MockBFFService_ProcessRequest_Call) RunAndReturn(run func(wasabi.Connection, *request.Request) error) *MockBFFService_ProcessRequest_Call

type RateLimits

type RateLimits struct {
	Groups  []GroupRateLimits `mapstructure:"groups"`
	General GeneralRateLimits `mapstructure:"general"`
}

type Service

type Service struct {
	// contains filtered or unexported fields
}

func NewSevice

func NewSevice(cfg *Config, handler BFFService) (*Service, error)

NewSevice creates a new instance of Service with the provided configuration and handler. It takes cfg of type *Config and handler of type BFFService. It returns a pointer to a Service struct.

func (*Service) Addr

func (s *Service) Addr() net.Addr

Addr returns the network address the server is listening on. It takes no parameters. It returns a net.Addr which represents the server's network address.

func (*Service) Handle

func (s *Service) Handle(conn wasabi.Connection, r wasabi.Request) error

Handle processes a request received on a connection and routes it based on the request type. It takes conn of type wasabi.Connection and r of type wasabi.Request. It returns an error if the request type is unsupported or if the request type is empty. If the request type is core.TextMessage or core.BinaryMessage, it passes the request through to the handler. For other request types, it processes the request using the handler.

func (*Service) HealthCheck

func (s *Service) HealthCheck(w http.ResponseWriter, _ *http.Request)

HealthCheck handles HTTP requests for checking the health status of the service. It takes a ResponseWriter to write the HTTP response and a Request which represents the client's request. It returns an HTTP status code 200 (OK) and a plain text message "OK".

func (*Service) Run

func (s *Service) Run(ctx context.Context) error

Run starts the service and listens for incoming connections. It takes a context.Context parameter which is used to manage the lifecycle of the service. It returns an error if the server fails to start or close properly. The function sets up a dispatcher, a connection registry, and a channel endpoint with middleware. It also handles graceful shutdown when the context is done.