 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Index ¶
- Variables
- func Write(client Client, writer Writer, msg message.Msg) error
- type Client
- type Closer
- type ConnectError
- type InvalidTimeoutError
- type InvalidURIError
- type MessageChanFunc
- type Mock
- type MockErr
- type MockSession
- type MockWriter
- type NsFilterFunc
- type Reader
- type Session
- type VersionError
- type Writer
Constants ¶
This section is empty.
Variables ¶
var ErrInvalidCert = errors.New("invalid cert error")
    ErrInvalidCert represents the error returned when a specified certificate was not valid
Functions ¶
Types ¶
type Client ¶
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 ¶
InvalidURIError wraps the underlying error when the provided URI is not parsable by mgo.
func (InvalidURIError) Error ¶
func (e InvalidURIError) Error() string
type MessageChanFunc ¶
MessageChanFunc represents the func signature needed to send messages to downstream adaptors.
type Mock ¶
type Mock struct {
	Closed bool
}
    Mock can be used for mocking tests that need no actual client or Session.
type MockErr ¶
type MockErr struct {
}
    MockErr can be used for mocking tests that need no actual client or Session.
type MockSession ¶
type MockSession struct {
}
    MockSession can be used for mocking tests the do not need to use anything in the Session.
type MockWriter ¶
type MockWriter struct {
	MsgCount int
}
    MockWriter can be used to count the number of messages sent to Write.
type NsFilterFunc ¶
NsFilterFunc represents the func signature needed to filter while Read()ing.
type Reader ¶
type Reader interface {
	Read(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 ¶
VersionError represents any failure in attempting to obtain the version from the provided uri.
func (VersionError) Error ¶
func (e VersionError) Error() string