protobuf

Documentation

Overview

Package protobuf is a generated GoMock package.

Index

• type AggregatedDecoder
  • func NewAggregatedDecoder(p AggregatedDecoderPool) *AggregatedDecoder
  • func (d *AggregatedDecoder) Close()
  • func (d *AggregatedDecoder) Decode(b []byte) error
  • func (d AggregatedDecoder) EncodeNanos() int64
  • func (d AggregatedDecoder) ID() []byte
  • func (d AggregatedDecoder) StoragePolicy() (policy.StoragePolicy, error)
  • func (d AggregatedDecoder) TimeNanos() int64
  • func (d AggregatedDecoder) Value() float64
• type AggregatedDecoderPool
  • func NewAggregatedDecoderPool(opts pool.ObjectPoolOptions) AggregatedDecoderPool
• type AggregatedEncoder
  • func NewAggregatedEncoder(p pool.BytesPool) AggregatedEncoder
• type Buffer
  • func NewBuffer(buf []byte, p pool.BytesPool) Buffer
  • func (b Buffer) Bytes() []byte
  • func (b *Buffer) Close()
  • func (b *Buffer) Truncate(n int)
• type MockUnaggregatedEncoder
  • func NewMockUnaggregatedEncoder(ctrl *gomock.Controller) *MockUnaggregatedEncoder
  • func (m *MockUnaggregatedEncoder) EXPECT() *MockUnaggregatedEncoderMockRecorder
  • func (m *MockUnaggregatedEncoder) EncodeMessage(arg0 encoding.UnaggregatedMessageUnion) error
  • func (m *MockUnaggregatedEncoder) Len() int
  • func (m *MockUnaggregatedEncoder) Relinquish() Buffer
  • func (m *MockUnaggregatedEncoder) Reset(arg0 []byte)
  • func (m *MockUnaggregatedEncoder) Truncate(arg0 int) error
• type MockUnaggregatedEncoderMockRecorder
  • func (mr *MockUnaggregatedEncoderMockRecorder) EncodeMessage(arg0 interface{}) *gomock.Call
  • func (mr *MockUnaggregatedEncoderMockRecorder) Len() *gomock.Call
  • func (mr *MockUnaggregatedEncoderMockRecorder) Relinquish() *gomock.Call
  • func (mr *MockUnaggregatedEncoderMockRecorder) Reset(arg0 interface{}) *gomock.Call
  • func (mr *MockUnaggregatedEncoderMockRecorder) Truncate(arg0 interface{}) *gomock.Call
• type UnaggregatedEncoder
  • func NewUnaggregatedEncoder(opts UnaggregatedOptions) UnaggregatedEncoder
• type UnaggregatedIterator
  • func NewUnaggregatedIterator(reader encoding.ByteReadScanner, opts UnaggregatedOptions) UnaggregatedIterator
• type UnaggregatedOptions
  • func NewUnaggregatedOptions() UnaggregatedOptions

Types

type AggregatedDecoder

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

AggregatedDecoder is a decoder for decoding aggregated metrics.

func NewAggregatedDecoder

func NewAggregatedDecoder(p AggregatedDecoderPool) *AggregatedDecoder

NewAggregatedDecoder creates an aggregated decoder.

func (*AggregatedDecoder) Close

func (d *AggregatedDecoder) Close()

Close closes the decoder.

func (*AggregatedDecoder) Decode

func (d *AggregatedDecoder) Decode(b []byte) error

Decode decodes the aggregated metric from the given bytes.

func (AggregatedDecoder) EncodeNanos

func (d AggregatedDecoder) EncodeNanos() int64

EncodeNanos returns the decoded encodeNanos.

func (AggregatedDecoder) ID

func (d AggregatedDecoder) ID() []byte

ID returns the decoded id.

func (AggregatedDecoder) StoragePolicy

func (d AggregatedDecoder) StoragePolicy() (policy.StoragePolicy, error)

StoragePolicy returns the decoded storage policy.

func (AggregatedDecoder) TimeNanos

func (d AggregatedDecoder) TimeNanos() int64

TimeNanos returns the decoded timestamp.

func (AggregatedDecoder) Value

func (d AggregatedDecoder) Value() float64

Value returns the decoded value.

type AggregatedDecoderPool

type AggregatedDecoderPool interface {
	Init()
	Get() *AggregatedDecoder
	Put(d *AggregatedDecoder)
}

AggregatedDecoderPool is a pool of aggregated decoders.

func NewAggregatedDecoderPool

func NewAggregatedDecoderPool(opts pool.ObjectPoolOptions) AggregatedDecoderPool

NewAggregatedDecoderPool creates a new pool for aggregated decoders.

type AggregatedEncoder

type AggregatedEncoder interface {
	// Encode encodes a metric with an applicable storage policy,
	// alongside the time at which encoding happens.
	Encode(m aggregated.MetricWithStoragePolicy, encodedAtNanos int64) error

	// Buffer returns the encoded buffer.
	Buffer() Buffer
}

AggregatedEncoder is an encoder for encoding aggregated metrics.

func NewAggregatedEncoder

func NewAggregatedEncoder(p pool.BytesPool) AggregatedEncoder

NewAggregatedEncoder creates a new aggregated encoder.

type Buffer

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

Buffer contains a byte slice backed by an optional bytes pool.

func NewBuffer

func NewBuffer(buf []byte, p pool.BytesPool) Buffer

NewBuffer create a new buffer.

func (Buffer) Bytes

func (b Buffer) Bytes() []byte

Bytes returns the raw byte slice.

func (*Buffer) Close

func (b *Buffer) Close()

Close closes the buffer.

func (*Buffer) Truncate

func (b *Buffer) Truncate(n int)

Truncate truncates the raw byte slice.

type MockUnaggregatedEncoder

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

MockUnaggregatedEncoder is a mock of UnaggregatedEncoder interface

func NewMockUnaggregatedEncoder

func NewMockUnaggregatedEncoder(ctrl *gomock.Controller) *MockUnaggregatedEncoder

NewMockUnaggregatedEncoder creates a new mock instance

func (*MockUnaggregatedEncoder) EXPECT

func (m *MockUnaggregatedEncoder) EXPECT() *MockUnaggregatedEncoderMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockUnaggregatedEncoder) EncodeMessage

func (m *MockUnaggregatedEncoder) EncodeMessage(arg0 encoding.UnaggregatedMessageUnion) error

EncodeMessage mocks base method

func (*MockUnaggregatedEncoder) Len

func (m *MockUnaggregatedEncoder) Len() int

Len mocks base method

func (*MockUnaggregatedEncoder) Relinquish

func (m *MockUnaggregatedEncoder) Relinquish() Buffer

Relinquish mocks base method

func (*MockUnaggregatedEncoder) Reset

func (m *MockUnaggregatedEncoder) Reset(arg0 []byte)

Reset mocks base method

func (*MockUnaggregatedEncoder) Truncate

func (m *MockUnaggregatedEncoder) Truncate(arg0 int) error

Truncate mocks base method

type MockUnaggregatedEncoderMockRecorder

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

MockUnaggregatedEncoderMockRecorder is the mock recorder for MockUnaggregatedEncoder

func (*MockUnaggregatedEncoderMockRecorder) EncodeMessage

func (mr *MockUnaggregatedEncoderMockRecorder) EncodeMessage(arg0 interface{}) *gomock.Call

EncodeMessage indicates an expected call of EncodeMessage

func (*MockUnaggregatedEncoderMockRecorder) Len

func (mr *MockUnaggregatedEncoderMockRecorder) Len() *gomock.Call

Len indicates an expected call of Len

func (*MockUnaggregatedEncoderMockRecorder) Relinquish

func (mr *MockUnaggregatedEncoderMockRecorder) Relinquish() *gomock.Call

Relinquish indicates an expected call of Relinquish

func (*MockUnaggregatedEncoderMockRecorder) Reset

func (mr *MockUnaggregatedEncoderMockRecorder) Reset(arg0 interface{}) *gomock.Call

Reset indicates an expected call of Reset

func (*MockUnaggregatedEncoderMockRecorder) Truncate

func (mr *MockUnaggregatedEncoderMockRecorder) Truncate(arg0 interface{}) *gomock.Call

Truncate indicates an expected call of Truncate

type UnaggregatedEncoder

type UnaggregatedEncoder interface {
	// Len returns the number of bytes accumulated in the encoder so far.
	Len() int

	// Reset resets the encoder buffer with optional initial data.
	Reset(initData []byte)

	// Truncate discards all but the first n encoded bytes but continues to use
	// the same allocated storage. If n is negative or greater than the length of
	// encoded buffer, an error is returned.
	Truncate(n int) error

	// EncodeMessage encodes an unaggregated message.
	EncodeMessage(msg encoding.UnaggregatedMessageUnion) error

	// Relinquish relinquishes ownership of the encoded byte stream to the caller,
	// and resets the internal encoding buffer.
	Relinquish() Buffer
}

UnaggregatedEncoder encodes unaggregated metrics.

func NewUnaggregatedEncoder

func NewUnaggregatedEncoder(opts UnaggregatedOptions) UnaggregatedEncoder

NewUnaggregatedEncoder creates a new unaggregated encoder.

type UnaggregatedIterator

type UnaggregatedIterator interface {
	// Next returns true if there are more items to decode.
	Next() bool

	// Current returns the current decoded value.
	Current() encoding.UnaggregatedMessageUnion

	// Err returns the error encountered during decoding, if any.
	Err() error

	// Close closes the iterator.
	Close()
}

UnaggregatedIterator decodes unaggregated metrics.

func NewUnaggregatedIterator

func NewUnaggregatedIterator(
	reader encoding.ByteReadScanner,
	opts UnaggregatedOptions,
) UnaggregatedIterator

NewUnaggregatedIterator creates a new unaggregated iterator.

type UnaggregatedOptions

type UnaggregatedOptions interface {
	// SetBytesPool sets the bytes pool.
	SetBytesPool(value pool.BytesPool) UnaggregatedOptions

	// BytesPool returns the bytes pool.
	BytesPool() pool.BytesPool

	// SetInitBufferSize sets the initial buffer size.
	SetInitBufferSize(value int) UnaggregatedOptions

	// InitBufferSize returns the initial buffer size.
	InitBufferSize() int

	// SetMaxMessageSize sets the maximum message size.
	SetMaxMessageSize(value int) UnaggregatedOptions

	// MaxMessageSize returns the maximum message size.
	MaxMessageSize() int
}

UnaggregatedOptions provide a set of options for the unaggregated encoder and iterator.

func NewUnaggregatedOptions

func NewUnaggregatedOptions() UnaggregatedOptions

NewUnaggregatedOptions create a new set of unaggregated options.