adapter

Documentation

Index

• type AdapterInterface
• type BaseAdapter
  • func NewBaseAdapter(name string) *BaseAdapter
  • func (a *BaseAdapter) GetName() string
  • func (a *BaseAdapter) SetLogger(logger *logrus.Entry)

Types

type AdapterInterface

type AdapterInterface interface {
	Setup() error
	Close() error
	GetName() string
	SetLogger(logger *logrus.Entry)
}

Interface implements basic adapter functions. All new adapters must inherit BaseAdapter and implement only Setup() and Close() functions.

type BaseAdapter

type BaseAdapter struct {
	Logger *logrus.Entry
	// contains filtered or unexported fields
}

Adapter structure contains an adapter name. All new adapters must inherit BaseAdapter and implement only Setup() and Close() functions from AdapterInterface.

func NewBaseAdapter

func NewBaseAdapter(name string) *BaseAdapter

Function allocates BaseAdapter structure with the name.

func (*BaseAdapter) GetName

func (a *BaseAdapter) GetName() string

Function returns the name of an adapter.

func (*BaseAdapter) SetLogger

func (a *BaseAdapter) SetLogger(logger *logrus.Entry)

Function sets the logger for internal using in the adapter.