models

Documentation

Index

• type BrokerMessage
• type ConnectionVariables
• type Reader
• type SidecarConnections
• type SidecarFactory
• type Writer

Types

type BrokerMessage

type BrokerMessage struct {
	Data interface{} `json:"data"`
}

BrokerMessage is the struct that represents the client's request format

type ConnectionVariables

type ConnectionVariables struct {
	ReadEnvVar  string
	WriteEnvVar string
}

ConnectionVariables is the structure resposible for storing enviroment variable names regarding connection ports for sidecars

type Reader

type Reader interface {
	ReadMessage(ctx context.Context, channel string) ([]byte, error)
	Commit(ctx context.Context, channel string) error
	Close() error
}

Reader reads from a message broker

type SidecarConnections

type SidecarConnections struct {
	InPort  int32
	OutPort int32
}

SidecarConnections object to store a sidecar's connectio ports

type SidecarFactory

type SidecarFactory func(app *meta.App, conn *SidecarConnections, opts ...k8s.ContainerOption) (corev1.Container, []corev1.EnvVar)

SidecarFactory function type responsible for creating a sidecar for a broker

type Writer

type Writer interface {
	WriteMessage(channel string, msg []byte) error
	Close()
}

Writer writes messages in a message broker