client

Documentation

Index

• Variables
• type ByteReader
  • func NewByteReader(r io.Reader) (br *ByteReader)
  • func (br *ByteReader) Read(p []byte) (n int, err error)
• type Client
  • func NewClient(baseURL string) (c *Client)
  • func (c *Client) BackupLog(name string, w io.Writer) (err error)
  • func (c *Client) CreateLog(name string, config api.LogConfig) (r api.CreateLogResponse, err error)
  • func (c *Client) DeleteLog(name string) (err error)
  • func (c *Client) GetLog(name string) (r api.GetLogResponse, err error)
  • func (c *Client) ListLogs() (r api.ListLogsResponse, err error)
  • func (c *Client) NewConsumer(name string, params ConsumerParams, options ConsumerOptions) (co *Consumer, err error)
  • func (c *Client) NewProducer(name string, options ProducerOptions) (p *Producer, err error)
  • func (c *Client) ReadRecord(logName string, params api.ReadRecordParams) (r log.Record, err error)
  • func (c *Client) ReadRecordsBatch(logName string, params api.ReadRecordsBatchParams, bufferSize int, timeout int, ...) (err error)
  • func (c *Client) ReadRecordsTCP(name string, params api.ReadRecordsTCPParams, flag recio.IOMode, ...) (tr *tcp.TCPReader, err error)
  • func (c *Client) RestoreLog(name string, r io.Reader) (err error)
  • func (c *Client) TruncateLog(name string) (err error)
  • func (c *Client) WriteRecord(logName string, record log.Record) (r api.WriteRecordResponse, err error)
  • func (c *Client) WriteRecordsBatch(logName string, bufferSize int, fn RecordsWriterHandler) (r api.WriteRecordsBatchResponse, err error)
  • func (c *Client) WriteRecordsTCP(logName string, flag recio.IOMode, writeBufferSize int, timeout int) (tw *tcp.TCPWriter, err error)
• type Consumer
  • func (co *Consumer) Close() (err error)
  • func (co *Consumer) HandleError(h ErrorHandler)
  • func (co *Consumer) Read(r *log.Record) (n int, err error)
• type ConsumerOptions
• type ConsumerParams
• type ErrorHandler
• type Producer
  • func (p *Producer) Close() (err error)
  • func (p *Producer) Flush() (err error)
  • func (p *Producer) HandleError(h ErrorHandler)
  • func (p *Producer) HandleSync(h SyncHandler)
  • func (p *Producer) Write(r *log.Record) (n int, err error)
• type ProducerOptions
• type RecordsReaderHandler
• type RecordsWriterHandler
• type SyncHandler
• type Whence

Variables

var (
	DefaultConsumerOptions = ConsumerOptions{
		ReadTimeout:     30,
		ReadBufferSize:  1 << 20,
		WriteBufferSize: 1 << 20,
		IOMode:          recio.ModeAuto,
	}

	DefaultConsumerParams = ConsumerParams{
		Whence:   SeekOrigin,
		Position: 0,
		Count:    -1,
		Follow:   false,
	}
)

var (
	DefaultLogConfig = api.LogConfig{
		MaxRecordSize:   1 << 20,
		IndexAfterSize:  1 << 20,
		SegmentMaxCount: -1,
		SegmentMaxSize:  1 << 30,
		SegmentMaxAge:   -1,
		LogMaxCount:     -1,
		LogMaxSize:      -1,
		LogMaxAge:       -1,
	}
)

var (
	DefaultProducerOptions = ProducerOptions{
		ReadTimeout:     30,
		ReadBufferSize:  1 << 20,
		WriteBufferSize: 1 << 20,
		IOMode:          recio.ModeAuto,
	}
)

Types

type ByteReader

type ByteReader struct {
	// contains filtered or unexported fields
}

func NewByteReader

func NewByteReader(r io.Reader) (br *ByteReader)

func (*ByteReader) Read

func (br *ByteReader) Read(p []byte) (n int, err error)

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(baseURL string) (c *Client)

func (*Client) BackupLog

func (c *Client) BackupLog(name string, w io.Writer) (err error)

func (*Client) CreateLog

func (c *Client) CreateLog(name string, config api.LogConfig) (r api.CreateLogResponse, err error)

func (*Client) DeleteLog

func (c *Client) DeleteLog(name string) (err error)

func (*Client) GetLog

func (c *Client) GetLog(name string) (r api.GetLogResponse, err error)

func (*Client) ListLogs

func (c *Client) ListLogs() (r api.ListLogsResponse, err error)

func (*Client) NewConsumer

func (c *Client) NewConsumer(name string, params ConsumerParams, options ConsumerOptions) (co *Consumer, err error)

func (*Client) NewProducer

func (c *Client) NewProducer(name string, options ProducerOptions) (p *Producer, err error)

func (*Client) ReadRecord

func (c *Client) ReadRecord(logName string, params api.ReadRecordParams) (r log.Record, err error)

func (*Client) ReadRecordsBatch

func (c *Client) ReadRecordsBatch(logName string, params api.ReadRecordsBatchParams, bufferSize int, timeout int, fn RecordsReaderHandler) (err error)

func (*Client) ReadRecordsTCP

func (c *Client) ReadRecordsTCP(name string, params api.ReadRecordsTCPParams, flag recio.IOMode, readBufferSize int, timeout int) (tr *tcp.TCPReader, err error)

func (*Client) RestoreLog

func (c *Client) RestoreLog(name string, r io.Reader) (err error)

func (*Client) TruncateLog

func (c *Client) TruncateLog(name string) (err error)

func (*Client) WriteRecord

func (c *Client) WriteRecord(logName string, record log.Record) (r api.WriteRecordResponse, err error)

func (*Client) WriteRecordsBatch

func (c *Client) WriteRecordsBatch(logName string, bufferSize int, fn RecordsWriterHandler) (r api.WriteRecordsBatchResponse, err error)

func (*Client) WriteRecordsTCP

func (c *Client) WriteRecordsTCP(logName string, flag recio.IOMode, writeBufferSize int, timeout int) (tw *tcp.TCPWriter, err error)

type Consumer

type Consumer struct {
	// contains filtered or unexported fields
}

func (*Consumer) Close

func (co *Consumer) Close() (err error)

func (*Consumer) HandleError

func (co *Consumer) HandleError(h ErrorHandler)

func (*Consumer) Read

func (co *Consumer) Read(r *log.Record) (n int, err error)

type ConsumerOptions

type ConsumerOptions struct {
	ReadTimeout     int
	ReadBufferSize  int
	WriteBufferSize int
	IOMode          recio.IOMode
}

type ConsumerParams

type ConsumerParams struct {
	Whence   Whence `schema:"whence"`
	Position int64  `schema:"position"`
	Count    int64  `schema:"count"`
	Follow   bool   `schema:"follow"`
}

type ErrorHandler

type ErrorHandler func(err error)

type Producer

type Producer struct {
	// contains filtered or unexported fields
}

func (*Producer) Close

func (p *Producer) Close() (err error)

func (*Producer) Flush

func (p *Producer) Flush() (err error)

func (*Producer) HandleError

func (p *Producer) HandleError(h ErrorHandler)

func (*Producer) HandleSync

func (p *Producer) HandleSync(h SyncHandler)

func (*Producer) Write

func (p *Producer) Write(r *log.Record) (n int, err error)

type ProducerOptions

type ProducerOptions struct {
	ReadTimeout     int
	ReadBufferSize  int
	WriteBufferSize int
	IOMode          recio.IOMode
}

type RecordsReaderHandler

type RecordsReaderHandler func(w recio.Reader) (err error)

type RecordsWriterHandler

type RecordsWriterHandler func(w recio.Writer) (err error)

type SyncHandler

type SyncHandler func(syncProgress log.SyncProgress)

type Whence

type Whence string

const (
	SeekOrigin  Whence = "origin"  // Seek from the log origin (position 0).
	SeekStart   Whence = "start"   // Seek from the first available record.
	SeekCurrent Whence = "current" // Seek from the current position.
	SeekEnd     Whence = "end"     // Seek from the end of the log.
)