transports

Documentation

Index

• type ExtendedReader
• type Transport
• type TransportInstance

Types

type ExtendedReader

type ExtendedReader interface {
	io.Reader
	io.ByteReader
	// Peek returns the next n bytes without advancing the reader.
	Peek(int) ([]byte, error)
	// Buffered returns the number of bytes that can be read from the current buffer.
	Buffered() int
}

type Transport

type Transport interface {
	io.Closer
	// GetTransportCode Get the short code used to identify this transport (As used in the connection string)
	GetTransportCode() string
	// GetTransportName Get a human-readable name for this transport
	GetTransportName() string
	// CreateTransportInstance creates transport instance
	CreateTransportInstance(transportUrl url.URL, options map[string][]string, _options ...options.WithOption) (TransportInstance, error)
}

type TransportInstance

type TransportInstance interface {
	fmt.Stringer
	io.Closer
	Connect() error
	ConnectWithContext(ctx context.Context) error

	IsConnected() bool

	// FillBuffer fills the buffer `until` false (Useful in conjunction if you want GetNumBytesAvailableInBuffer)
	FillBuffer(until func(pos uint, currentByte byte, reader ExtendedReader) bool) error
	// GetNumBytesAvailableInBuffer returns the bytes currently available in buffer (!!!Careful: if you looking for a termination you have to use FillBuffer)
	GetNumBytesAvailableInBuffer() (uint32, error)
	PeekReadableBytes(numBytes uint32) ([]byte, error)
	Read(numBytes uint32) ([]byte, error)

	Write(data []byte) error
}