client

Documentation

Index

• Variables
• func Write(client Client, writer Writer, msg message.Msg) (message.Msg, error)
• type Client
• type Closer
• type ConnectError
  • func (e ConnectError) Error() string
• type InvalidTimeoutError
  • func (e InvalidTimeoutError) Error() string
• type InvalidURIError
  • func (e InvalidURIError) Error() string
• type MessageChanFunc
• type MessageSet
• type Mock
  • func (c *Mock) Close()
  • func (c *Mock) Connect() (Session, error)
• type MockErr
  • func (c *MockErr) Connect() (Session, error)
• type MockErrWriter
  • func (w *MockErrWriter) Write(msg message.Msg) func(Session) (message.Msg, error)
• type MockReader
  • func (r *MockReader) Read(_ map[string]MessageSet, filterFn NsFilterFunc) MessageChanFunc
• type MockSession
  • func (s *MockSession) Close()
• type MockWriter
  • func (w *MockWriter) Write(msg message.Msg) func(Session) (message.Msg, error)
• type NsFilterFunc
• type Reader
• type Session
• type VersionError
  • func (e VersionError) Error() string
• type Writer

Variables

var (
	// ErrMockConnect returns a connection error for use in tests.
	ErrMockConnect = errors.New("connect failed")
	// ErrMockWrite returns a write error for use in tests.
	ErrMockWrite = errors.New("write failed")
)

var ErrInvalidCert = errors.New("invalid cert error")

ErrInvalidCert represents the error returned when a specified certificate was not valid

Functions

func Write

func Write(client Client, writer Writer, msg message.Msg) (message.Msg, error)

Write encapsulates the function of determining which function to call based on the msg.OP() and also wraps the function call with a Session.

Types

type Client

type Client interface {
	Connect() (Session, error)
}

Client provides a standard interface for interacting with the underlying sources/sinks.

type Closer

type Closer interface {
	Close()
}

Closer provides a standard interface for closing a client or session

type ConnectError

type ConnectError struct {
	Reason string
}

ConnectError wraps the underlying error when a failure occurs dialing the database.

func (ConnectError) Error

func (e ConnectError) Error() string

type InvalidTimeoutError

type InvalidTimeoutError struct {
	Timeout string
}

InvalidTimeoutError wraps the underlying error when the provided is not parsable time.ParseDuration.

func (InvalidTimeoutError) Error

func (e InvalidTimeoutError) Error() string

type InvalidURIError

type InvalidURIError struct {
	URI string
	Err string
}

InvalidURIError wraps the underlying error when the provided URI is not parsable by mgo.

func (InvalidURIError) Error

func (e InvalidURIError) Error() string

type MessageChanFunc

type MessageChanFunc func(Session, chan struct{}) (chan MessageSet, error)

MessageChanFunc represents the func signature needed to send messages to downstream adaptors.

type MessageSet

type MessageSet struct {
	Msg       message.Msg
	Timestamp int64
	Mode      commitlog.Mode
}

MessageSet encapsulates the data being sent down the pipeline and its associated attributes.

type Mock

type Mock struct {
	Closed bool
}

Mock can be used for mocking tests that need no actual client or Session.

func (*Mock) Close

func (c *Mock) Close()

Close satisfies the Closer interface.

func (*Mock) Connect

func (c *Mock) Connect() (Session, error)

Connect satisfies the Client interface.

type MockErr

type MockErr struct {
}

MockErr can be used for mocking tests that need no actual client or Session.

func (*MockErr) Connect

func (c *MockErr) Connect() (Session, error)

Connect satisfies the Client interface.

type MockErrWriter

type MockErrWriter struct {
}

MockErrWriter can be used to similate write errors in tests.

func (*MockErrWriter) Write

func (w *MockErrWriter) Write(msg message.Msg) func(Session) (message.Msg, error)

Writer satisfies the Writer interface.

type MockReader

type MockReader struct {
	MsgCount int
}

MockReader can be used to send a random number of messages

func (*MockReader) Read

func (r *MockReader) Read(_ map[string]MessageSet, filterFn NsFilterFunc) MessageChanFunc

type MockSession

type MockSession struct {
}

MockSession can be used for mocking tests the do not need to use anything in the Session.

func (*MockSession) Close

func (s *MockSession) Close()

Close satisfies the Closer interface.

type MockWriter

type MockWriter struct {
	MsgCount int
}

MockWriter can be used to count the number of messages sent to Write.

func (*MockWriter) Write

func (w *MockWriter) Write(msg message.Msg) func(Session) (message.Msg, error)

Writer satisfies the Writer interface.

type NsFilterFunc

type NsFilterFunc func(string) bool

NsFilterFunc represents the func signature needed to filter while Read()ing.

type Reader

type Reader interface {
	Read(map[string]MessageSet, NsFilterFunc) MessageChanFunc
}

Reader represents the ability to send messages down the pipe and is only needed for adaptors acting as a Source node.

type Session

type Session interface {
}

Session represents the connection to the underlying service.

type VersionError

type VersionError struct {
	URI string
	V   string
	Err string
}

VersionError represents any failure in attempting to obtain the version from the provided uri.

func (VersionError) Error

func (e VersionError) Error() string

type Writer

type Writer interface {
	Write(message.Msg) func(Session) (message.Msg, error)
}

Writer represents all possible functions needing to be implemented to handle messages.