connectorv1

Documentation

Index

• Constants
• type Bindable
  • func NewBindable(data []byte, tp BindableType) Bindable
• type BindableType
• type Config
• type Connector
• type ConnectorOpts
• type ConnectorWorker
  • func NewConnectorWorker(connector Connector, options ...Option) (ConnectorWorker, error)
• type Forwarder
• type Headers
• type HealthCheckFunc
• type HttpError
  • func (he *HttpError) Error() string
• type InboundConnector
• type InboundDescriptor
• type InboundRequest
• type InboundResponse
• type Ingress
• type Logger
• type MessageDescriptor
• type MessageType
• type Option
  • func WithConfig(cfg any) Option
  • func WithConfigBasePath(path string) Option
  • func WithForwarder(fwd Forwarder) Option
• type OutboundConnector
• type OutboundDescriptor
• type OutboundRequest
• type OutboundResponse
• type StartContext
• type StopContext

Constants

const (
	BindableTypeJson    = "json"
	BindableTypeYaml    = "yaml"
	BindableTypeUnknown = ""
)

Types

type Bindable

type Bindable interface {
	Raw() ([]byte, error)
	Bind(any) error
}

func NewBindable

func NewBindable(data []byte, tp BindableType) Bindable

type BindableType

type BindableType string

type Config

type Config struct {
	Ingress         []ingressConfig `yaml:"ingress"`
	ConnectorConfig connectorConfig `yaml:"config"`
}

type Connector

type Connector interface {
	// Start can be used to initialise your server or client
	// Note: This function should return and not block
	Start(ctx StartContext) error
	Stop(ctx StopContext) error
}

type ConnectorOpts

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

type ConnectorWorker

type ConnectorWorker interface {
	Run()
}

func NewConnectorWorker

func NewConnectorWorker(connector Connector, options ...Option) (ConnectorWorker, error)

type Forwarder

type Forwarder interface {
	Forward(name string, body []byte, headers Headers) (InboundResponse, error)
}

type Headers

type Headers = map[string]string

type HealthCheckFunc

type HealthCheckFunc func() error

type HttpError

type HttpError struct {
	HttpCode int    `json:"http_code"`
	Reason   string `json:"reason"`
	Raw      []byte `json:"raw"`
}

func (*HttpError) Error

func (he *HttpError) Error() string

type InboundConnector

type InboundConnector interface {
	Connector
}

type InboundDescriptor

type InboundDescriptor interface {
	MessageDescriptor
}

type InboundRequest

type InboundRequest interface {
	MessageName() string
	MimeType() string
	// contains filtered or unexported methods
}

type InboundResponse

type InboundResponse interface {
	// contains filtered or unexported methods
}

type Ingress

type Ingress interface {
	ExternalAddress() string
	InternalPort() int
	InternalHost() string
}

type Logger

type Logger interface {
	Error(err error, format string, v ...interface{})
	Fatal(err error, format string, v ...interface{}) // this will crash the service
	Info(format string, v ...interface{})
	Warn(format string, v ...interface{})
	Debug(format string, v ...interface{})
}

type MessageDescriptor

type MessageDescriptor interface {
	Name() string
	MessageName() string
	MimeType() string
	MessageType() MessageType
	Config() Bindable
}

type MessageType

type MessageType string

const MessageTypeInbound MessageType = "inbound"

const MessageTypeOutbound MessageType = "outbound"

type Option

type Option = func(je *ConnectorOpts) *ConnectorOpts

func WithConfig

func WithConfig(cfg any) Option

func WithConfigBasePath

func WithConfigBasePath(path string) Option

func WithForwarder

func WithForwarder(fwd Forwarder) Option

type OutboundConnector

type OutboundConnector interface {
	Connector
	HandleOutboundRequest(request OutboundRequest) (any, Headers, error) // see line 26, please
}

type OutboundDescriptor

type OutboundDescriptor interface {
	MessageDescriptor
}

type OutboundRequest

type OutboundRequest interface {
	MessageName() string
	MimeType() string
	// contains filtered or unexported methods
}

type OutboundResponse

type OutboundResponse interface {
	// contains filtered or unexported methods
}

type StartContext

type StartContext interface {
	Config() Bindable
	Ingress(name string) (Ingress, error)
	InboundDescriptors() []InboundDescriptor
	OutboundDescriptors() []OutboundDescriptor
	Forwarder() Forwarder
	Log() Logger
	RegisterPeriodicHealthCheck(name string, fn HealthCheckFunc)
}

type StopContext

type StopContext interface {
	Log() Logger
}