getsvc

Documentation

Index

• type ChunkWriter
• type HeadPrm
  • func (p *HeadPrm) SetCommonParameters(common *util.CommonPrm)
  • func (p *HeadPrm) SetHeaderWriter(w HeaderWriter)
• type HeaderWriter
• type ObjectWriter
• type Option
  • func WithClientCache(v *cache.ClientCache) Option
  • func WithClientOptions(opts ...client.Option) Option
  • func WithLocalStorageEngine(e *engine.StorageEngine) Option
  • func WithLogger(l *logger.Logger) Option
  • func WithTraverserGenerator(t *util.TraverserGenerator) Option
  • func WithoutAssembly() Option
• type Prm
  • func (p *Prm) SetCommonParameters(common *util.CommonPrm)
  • func (p *Prm) SetObjectWriter(w ObjectWriter)
• type RangeHashPrm
  • func (p *RangeHashPrm) SetCommonParameters(common *util.CommonPrm)
  • func (p *RangeHashPrm) SetHashGenerator(v func() hash.Hash)
  • func (p *RangeHashPrm) SetRangeList(rngs []*objectSDK.Range)
• type RangeHashRes
  • func (r *RangeHashRes) Hashes() [][]byte
• type RangePrm
  • func (p *RangePrm) SetChunkWriter(w ChunkWriter)
  • func (p *RangePrm) SetCommonParameters(common *util.CommonPrm)
  • func (p *RangePrm) SetRange(rng *objectSDK.Range)
• type Service
  • func New(opts ...Option) *Service
  • func (s *Service) Get(ctx context.Context, prm Prm) error
  • func (s *Service) GetRange(ctx context.Context, prm RangePrm) error
  • func (s *Service) GetRangeHash(ctx context.Context, prm RangeHashPrm) (*RangeHashRes, error)
  • func (s *Service) Head(ctx context.Context, prm HeadPrm) error
• type SimpleObjectWriter
  • func NewSimpleObjectWriter() *SimpleObjectWriter
  • func (s *SimpleObjectWriter) Object() *object.Object
  • func (s *SimpleObjectWriter) WriteChunk(p []byte) error
  • func (s *SimpleObjectWriter) WriteHeader(obj *object.Object) error

Types

type ChunkWriter

type ChunkWriter interface {
	WriteChunk([]byte) error
}

ChunkWriter is an interface of target component to write payload chunk.

type HeadPrm

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

HeadPrm groups parameters of Head service call.

func (*HeadPrm) SetCommonParameters

func (p *HeadPrm) SetCommonParameters(common *util.CommonPrm)

SetCommonParameters sets common parameters of the operation.

func (*HeadPrm) SetHeaderWriter

func (p *HeadPrm) SetHeaderWriter(w HeaderWriter)

SetHeaderWriter sets target component to write the object header.

type HeaderWriter

type HeaderWriter interface {
	WriteHeader(*object.Object) error
}

HeaderWriter is an interface of target component to write object header.

type ObjectWriter

type ObjectWriter interface {
	HeaderWriter
	ChunkWriter
}

ObjectWriter is an interface of target component to write object.

type Option

type Option func(*cfg)

Option is a Service's constructor option.

func WithClientCache

func WithClientCache(v *cache.ClientCache) Option

WithClientCache returns option to set cache of remote node clients.

func WithClientOptions

func WithClientOptions(opts ...client.Option) Option

WithClientOptions returns option to specify options of remote node clients.

func WithLocalStorageEngine

func WithLocalStorageEngine(e *engine.StorageEngine) Option

WithLocalStorageEngine returns option to set local storage instance.

func WithLogger

func WithLogger(l *logger.Logger) Option

WithLogger returns option to specify Get service's logger.

func WithTraverserGenerator

func WithTraverserGenerator(t *util.TraverserGenerator) Option

WithTraverserGenerator returns option to set generator of placement traverser to get the objects from containers.

func WithoutAssembly

func WithoutAssembly() Option

WithoutAssembly returns option to disable object assembling.

type Prm

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

Prm groups parameters of Get service call.

func (*Prm) SetCommonParameters

func (p *Prm) SetCommonParameters(common *util.CommonPrm)

SetCommonParameters sets common parameters of the operation.

func (*Prm) SetObjectWriter

func (p *Prm) SetObjectWriter(w ObjectWriter)

SetObjectWriter sets target component to write the object.

type RangeHashPrm

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

RangeHashPrm groups parameters of GetRange service call.

func (*RangeHashPrm) SetCommonParameters

func (p *RangeHashPrm) SetCommonParameters(common *util.CommonPrm)

SetCommonParameters sets common parameters of the operation.

func (*RangeHashPrm) SetHashGenerator

func (p *RangeHashPrm) SetHashGenerator(v func() hash.Hash)

SetHashGenerator sets constructor of hashing algorithm.

func (*RangeHashPrm) SetRangeList

func (p *RangeHashPrm) SetRangeList(rngs []*objectSDK.Range)

SetRangeList sets list of object payload ranges.

type RangeHashRes

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

func (*RangeHashRes) Hashes

func (r *RangeHashRes) Hashes() [][]byte

type RangePrm

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

RangePrm groups parameters of GetRange service call.

func (*RangePrm) SetChunkWriter

func (p *RangePrm) SetChunkWriter(w ChunkWriter)

SetChunkWriter sets target component to write the object payload range.

func (*RangePrm) SetCommonParameters

func (p *RangePrm) SetCommonParameters(common *util.CommonPrm)

SetCommonParameters sets common parameters of the operation.

func (*RangePrm) SetRange

func (p *RangePrm) SetRange(rng *objectSDK.Range)

SetRange sets range of the requested payload data.

type Service

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

Service utility serving requests of Object.Get service.

func New

func New(opts ...Option) *Service

New creates, initializes and returns utility serving Object.Get service requests.

func (*Service) Get

func (s *Service) Get(ctx context.Context, prm Prm) error

Get serves a request to get an object by address, and returns Streamer instance.

func (*Service) GetRange

func (s *Service) GetRange(ctx context.Context, prm RangePrm) error

GetRange serves a request to get an object by address, and returns Streamer instance.

func (*Service) GetRangeHash

func (s *Service) GetRangeHash(ctx context.Context, prm RangeHashPrm) (*RangeHashRes, error)

func (*Service) Head

func (s *Service) Head(ctx context.Context, prm HeadPrm) error

Head reads object header from container.

Returns ErrNotFound if the header was not received for the call. Returns SplitInfoError if object is virtual and raw flag is set.

type SimpleObjectWriter

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

func NewSimpleObjectWriter

func NewSimpleObjectWriter() *SimpleObjectWriter

func (*SimpleObjectWriter) Object

func (s *SimpleObjectWriter) Object() *object.Object

func (*SimpleObjectWriter) WriteChunk

func (s *SimpleObjectWriter) WriteChunk(p []byte) error

func (*SimpleObjectWriter) WriteHeader

func (s *SimpleObjectWriter) WriteHeader(obj *object.Object) error