object

Documentation

Index

• Constants
• func NewMultiTransport(p MultiTransportParams) (transport.ObjectTransport, error)
• func TypedHeaderSourceFromExtendedHeaders(hdrSrc service.ExtendedHeadersSource) extended.TypedHeaderSource
• func TypedHeaderSourceFromObject(obj *object.Object) extended.TypedHeaderSource
• type Address
• type CID
• type CapacityMeter
• type CreationPoint
• type EpochReceiver
• type Filter
• type GetRangeHashRequest
• type GetRangeHashResponse
• type GetRangeRequest
• type GetRangeResponse
• type Hash
• type Header
• type ID
• type Meta
• type MultiTransportParams
• type NetmapClient
• type Object
• type OperationParams
• type OwnerID
• type Params
• type Placer
• type QueryFilter
• type Range
• type RangeChopper
• type RangeDescriptor
• type RemoteService
  • func NewRemoteService(ps peers.Interface) RemoteService
• type RequestTargeter
• type Salitor
• type Service
  • func New(p *Params) (Service, error)
• type SystemHeader
• type UserHeader
• type Verb
• type WorkerPool

Constants

const (
	// KeyChild is a filter key to child link.
	KeyChild = "CHILD"

	// KeyPrev is a filter key to previous link.
	KeyPrev = "PREV"

	// KeyNext is a filter key to next link.
	KeyNext = "NEXT"

	// KeyID is a filter key to object ID.
	KeyID = "ID"

	// KeyCID is a filter key to container ID.
	KeyCID = "CID"

	// KeyOwnerID is a filter key to owner ID.
	KeyOwnerID = "OWNERID"

	// KeyRootObject is a filter key to objects w/o parent links.
	KeyRootObject = "ROOT_OBJECT"
)

Functions

func NewMultiTransport

func NewMultiTransport(p MultiTransportParams) (transport.ObjectTransport, error)

NewMultiTransport is an object transport component's constructor.

func TypedHeaderSourceFromExtendedHeaders

func TypedHeaderSourceFromExtendedHeaders(hdrSrc service.ExtendedHeadersSource) extended.TypedHeaderSource

TypedHeaderSourceFromExtendedHeaders wraps passed ExtendedHeadersSource and returns TypedHeaderSource interface.

func TypedHeaderSourceFromObject

func TypedHeaderSourceFromObject(obj *object.Object) extended.TypedHeaderSource

TypedHeaderSourceFromObject wraps passed object and returns TypedHeaderSource interface.

Types

type Address

type Address = refs.Address

Address is a type alias of Address from refs package of neofs-api-go.

type CID

type CID = refs.CID

CID is a type alias of CID from refs package of neofs-api-go.

type CapacityMeter

type CapacityMeter interface {
	RelativeAvailableCap() float64
	AbsoluteAvailableCap() uint64
}

CapacityMeter is an interface of node storage capacity meter.

type CreationPoint

type CreationPoint = object.CreationPoint

CreationPoint is a type alias of CreationPoint from object package of neofs-api-go.

type EpochReceiver

type EpochReceiver interface {
	Epoch() uint64
}

EpochReceiver is an interface of the container of epoch number with read access.

type Filter

type Filter = localstore.FilterPipeline

Filter is a type alias of FilterPipeline from localstore package.

type GetRangeHashRequest

type GetRangeHashRequest = object.GetRangeHashRequest

GetRangeHashRequest is a type alias of GetRangeResponse from object package of neofs-api-go.

type GetRangeHashResponse

type GetRangeHashResponse = object.GetRangeHashResponse

GetRangeHashResponse is a type alias of GetRangeHashResponse from object package of neofs-api-go.

type GetRangeRequest

type GetRangeRequest = object.GetRangeRequest

GetRangeRequest is a type alias of GetRangeRequest from object package of neofs-api-go.

type GetRangeResponse

type GetRangeResponse = object.GetRangeResponse

GetRangeResponse is a type alias of GetRangeResponse from object package of neofs-api-go.

type Hash

type Hash = hash.Hash

Hash is a type alias of Hash from hash package of neofs-api-go.

type Header

type Header = object.Header

Header is a type alias of Header from object package of neofs-api-go.

type ID

type ID = refs.ObjectID

ID is a type alias of ObjectID from refs package of neofs-api-go.

type Meta

type Meta = localstore.ObjectMeta

Meta is a type alias of ObjectMeta from localstore package.

type MultiTransportParams

type MultiTransportParams struct {
	AddressStore     storage.AddressStoreComponent
	EpochReceiver    EpochReceiver
	RemoteService    RemoteService
	Logger           *zap.Logger
	Key              *ecdsa.PrivateKey
	PutTimeout       time.Duration
	GetTimeout       time.Duration
	HeadTimeout      time.Duration
	SearchTimeout    time.Duration
	RangeHashTimeout time.Duration
	DialTimeout      time.Duration

	PrivateTokenStore session.PrivateTokenStore
}

MultiTransportParams groups the parameters for object transport component's constructor.

type NetmapClient

type NetmapClient = wrapper.Wrapper

type Object

type Object = object.Object

Object is a type alias of Object from object package of neofs-api-go.

type OperationParams

type OperationParams struct {
	Timeout   time.Duration
	LogErrors bool
}

OperationParams groups the parameters of particular object operation.

type OwnerID

type OwnerID = refs.OwnerID

OwnerID is a type alias of OwnerID from refs package of neofs-api-go.

type Params

type Params struct {
	CheckACL bool

	Assembly bool

	WindowSize int

	MaxProcessingSize uint64
	StorageCapacity   uint64
	PoolSize          int
	Salitor           Salitor
	LocalStore        localstore.Localstore
	Placer            Placer
	ObjectRestorer    transformer.ObjectRestorer
	RemoteService     RemoteService
	AddressStore      storage2.AddressStoreComponent
	Logger            *zap.Logger
	TokenStore        session.PrivateTokenStore
	EpochReceiver     EpochReceiver

	PlacementWrapper *placement.PlacementWrapper

	DialTimeout time.Duration

	Key *ecdsa.PrivateKey

	PutParams       OperationParams
	GetParams       OperationParams
	DeleteParams    OperationParams
	HeadParams      OperationParams
	SearchParams    OperationParams
	RangeParams     OperationParams
	RangeHashParams OperationParams

	Verifier verifier.Verifier

	Transformer transformer.Transformer

	MaxPayloadSize uint64

	// ACL pre-processor params
	ContainerStorage storage.Storage
	NetmapClient     *NetmapClient

	SGInfoReceiver storagegroup.InfoReceiver

	ExtendedACLSource eaclstorage.Storage
	// contains filtered or unexported fields
}

Params groups the parameters of Object service server's constructor.

type Placer

type Placer interface {
	IsContainerNode(ctx context.Context, addr multiaddr.Multiaddr, cid CID, previousNetMap bool) (bool, error)
	GetNodes(ctx context.Context, addr Address, usePreviousNetMap bool, excl ...multiaddr.Multiaddr) ([]multiaddr.Multiaddr, error)
}

Placer is an interface of placement component.

type QueryFilter

type QueryFilter = v1.Filter

QueryFilter is a type alias of Filter from query package of neofs-api-go.

type Range

type Range = object.Range

Range is a type alias of Range from object package of neofs-api-go.

type RangeChopper

type RangeChopper = _range.RangeChopper

RangeChopper is a type alias of RangeChopper from objio package.

type RangeDescriptor

type RangeDescriptor = _range.RangeDescriptor

RangeDescriptor is a type alias of RangeDescriptor from objio package.

type RemoteService

type RemoteService interface {
	Remote(context.Context, multiaddr.Multiaddr) (object.ServiceClient, error)
}

RemoteService is an interface of Object service client constructor.

func NewRemoteService

func NewRemoteService(ps peers.Interface) RemoteService

NewRemoteService is a remote service controller's constructor.

type RequestTargeter

type RequestTargeter interface {
	Target(context.Context, serviceRequest) requestTarget
}

RequestTargeter is an interface of request's ACL group calculator.

type Salitor

type Salitor func(data []byte, salt []byte) []byte

Salitor is a salting slice function.

type Service

type Service interface {
	grpc.Service
	CapacityMeter
	object.ServiceServer
}

Service is an interface of the server of Object service.

func New

func New(p *Params) (Service, error)

New is an Object service server's constructor.

type SystemHeader

type SystemHeader = object.SystemHeader

SystemHeader is a type alias of SystemHeader from object package of neofs-api-go.

type UserHeader

type UserHeader = object.UserHeader

UserHeader is a type alias of UserHeader from object package of neofs-api-go.

type Verb

type Verb = service.Token_Info_Verb

Verb is a type alias of Token_Info_Verb from service package of neofs-api-go.

type WorkerPool

type WorkerPool interface {
	Submit(func()) error
}

WorkerPool is an interface of go-routing pool.