Documentation
¶
Index ¶
- type Common
- func (x *Common) Delete(ctx context.Context, req *objectV2.DeleteRequest) (*objectV2.DeleteResponse, error)
- func (x *Common) Get(req *objectV2.GetRequest, stream GetObjectStream) error
- func (x *Common) GetRange(req *objectV2.GetRangeRequest, stream GetObjectRangeStream) error
- func (x *Common) GetRangeHash(ctx context.Context, req *objectV2.GetRangeHashRequest) (*objectV2.GetRangeHashResponse, error)
- func (x *Common) Head(ctx context.Context, req *objectV2.HeadRequest) (*objectV2.HeadResponse, error)
- func (x *Common) Init(state NodeState, nextHandler ServiceServer)
- func (x *Common) Put(ctx context.Context) (PutObjectStream, error)
- func (x *Common) Search(req *objectV2.SearchRequest, stream SearchStream) error
- type GetObjectRangeStream
- type GetObjectStream
- type MetricCollector
- func (m MetricCollector) Delete(ctx context.Context, request *object.DeleteRequest) (*object.DeleteResponse, error)
- func (m MetricCollector) Get(req *object.GetRequest, stream GetObjectStream) (err error)
- func (m MetricCollector) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
- func (m MetricCollector) GetRangeHash(ctx context.Context, request *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
- func (m MetricCollector) Head(ctx context.Context, request *object.HeadRequest) (*object.HeadResponse, error)
- func (m MetricCollector) Put(ctx context.Context) (PutObjectStream, error)
- func (m MetricCollector) Search(req *object.SearchRequest, stream SearchStream) error
- type MetricRegister
- type NodeState
- type PutObjectStream
- type ResponseService
- func (s *ResponseService) Delete(ctx context.Context, req *object.DeleteRequest) (*object.DeleteResponse, error)
- func (s *ResponseService) Get(req *object.GetRequest, stream GetObjectStream) error
- func (s *ResponseService) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
- func (s *ResponseService) GetRangeHash(ctx context.Context, req *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
- func (s *ResponseService) Head(ctx context.Context, req *object.HeadRequest) (*object.HeadResponse, error)
- func (s *ResponseService) Put(ctx context.Context) (PutObjectStream, error)
- func (s *ResponseService) Search(req *object.SearchRequest, stream SearchStream) error
- type SearchStream
- type ServiceServer
- type SignService
- func (s *SignService) Delete(ctx context.Context, req *object.DeleteRequest) (*object.DeleteResponse, error)
- func (s *SignService) Get(req *object.GetRequest, stream GetObjectStream) error
- func (s *SignService) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
- func (s *SignService) GetRangeHash(ctx context.Context, req *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
- func (s *SignService) Head(ctx context.Context, req *object.HeadRequest) (*object.HeadResponse, error)
- func (s *SignService) Put(ctx context.Context) (PutObjectStream, error)
- func (s *SignService) Search(req *object.SearchRequest, stream SearchStream) error
- type TransportSplitter
- func (c TransportSplitter) Delete(ctx context.Context, request *object.DeleteRequest) (*object.DeleteResponse, error)
- func (c *TransportSplitter) Get(req *object.GetRequest, stream GetObjectStream) error
- func (c TransportSplitter) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
- func (c TransportSplitter) GetRangeHash(ctx context.Context, request *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
- func (c TransportSplitter) Head(ctx context.Context, request *object.HeadRequest) (*object.HeadResponse, error)
- func (c TransportSplitter) Put(ctx context.Context) (PutObjectStream, error)
- func (c TransportSplitter) Search(req *object.SearchRequest, stream SearchStream) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Common ¶ added in v0.33.0
type Common struct {
// contains filtered or unexported fields
}
Common is an Object API ServiceServer which encapsulates logic spread to all object operations.
If underlying NodeState.IsMaintenance returns true, all operations are immediately failed with apistatus.NodeUnderMaintenance.
func (*Common) Delete ¶ added in v0.33.0
func (x *Common) Delete(ctx context.Context, req *objectV2.DeleteRequest) (*objectV2.DeleteResponse, error)
func (*Common) Get ¶ added in v0.33.0
func (x *Common) Get(req *objectV2.GetRequest, stream GetObjectStream) error
func (*Common) GetRange ¶ added in v0.33.0
func (x *Common) GetRange(req *objectV2.GetRangeRequest, stream GetObjectRangeStream) error
func (*Common) GetRangeHash ¶ added in v0.33.0
func (x *Common) GetRangeHash(ctx context.Context, req *objectV2.GetRangeHashRequest) (*objectV2.GetRangeHashResponse, error)
func (*Common) Head ¶ added in v0.33.0
func (x *Common) Head(ctx context.Context, req *objectV2.HeadRequest) (*objectV2.HeadResponse, error)
func (*Common) Init ¶ added in v0.33.0
func (x *Common) Init(state NodeState, nextHandler ServiceServer)
Init initializes the Common instance.
func (*Common) Put ¶ added in v0.33.0
func (x *Common) Put(ctx context.Context) (PutObjectStream, error)
func (*Common) Search ¶ added in v0.33.0
func (x *Common) Search(req *objectV2.SearchRequest, stream SearchStream) error
type GetObjectRangeStream ¶ added in v0.13.0
type GetObjectRangeStream interface {
util.ServerStream
Send(*object.GetRangeResponse) error
}
GetObjectRangeStream is an interface of NeoFS API v2 compatible payload range streamer.
type GetObjectStream ¶ added in v0.13.0
type GetObjectStream interface {
util.ServerStream
Send(*object.GetResponse) error
}
GetObjectStream is an interface of NeoFS API v2 compatible object streamer.
type MetricCollector ¶ added in v0.17.0
type MetricCollector struct {
// contains filtered or unexported fields
}
func NewMetricCollector ¶ added in v0.17.0
func NewMetricCollector(next ServiceServer, register MetricRegister) *MetricCollector
func (MetricCollector) Delete ¶ added in v0.17.0
func (m MetricCollector) Delete(ctx context.Context, request *object.DeleteRequest) (*object.DeleteResponse, error)
func (MetricCollector) Get ¶ added in v0.17.0
func (m MetricCollector) Get(req *object.GetRequest, stream GetObjectStream) (err error)
func (MetricCollector) GetRange ¶ added in v0.17.0
func (m MetricCollector) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
func (MetricCollector) GetRangeHash ¶ added in v0.17.0
func (m MetricCollector) GetRangeHash(ctx context.Context, request *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
func (MetricCollector) Head ¶ added in v0.17.0
func (m MetricCollector) Head(ctx context.Context, request *object.HeadRequest) (*object.HeadResponse, error)
func (MetricCollector) Put ¶ added in v0.17.0
func (m MetricCollector) Put(ctx context.Context) (PutObjectStream, error)
func (MetricCollector) Search ¶ added in v0.17.0
func (m MetricCollector) Search(req *object.SearchRequest, stream SearchStream) error
type MetricRegister ¶ added in v0.17.0
type MetricRegister interface {
IncGetReqCounter(success bool)
IncPutReqCounter(success bool)
IncHeadReqCounter(success bool)
IncSearchReqCounter(success bool)
IncDeleteReqCounter(success bool)
IncRangeReqCounter(success bool)
IncRangeHashReqCounter(success bool)
AddGetReqDuration(time.Duration)
AddPutReqDuration(time.Duration)
AddHeadReqDuration(time.Duration)
AddSearchReqDuration(time.Duration)
AddDeleteReqDuration(time.Duration)
AddRangeReqDuration(time.Duration)
AddRangeHashReqDuration(time.Duration)
AddPutPayload(int)
AddGetPayload(int)
}
type NodeState ¶ added in v0.33.0
type NodeState interface {
// IsMaintenance checks if node is under maintenance. Node MUST NOT serve
// local object operations. Node MUST respond with apistatus.NodeUnderMaintenance
// error if IsMaintenance returns true.
IsMaintenance() bool
}
NodeState is storage node state processed by Object service.
type PutObjectStream ¶ added in v0.17.0
type PutObjectStream interface {
Send(*object.PutRequest) error
CloseAndRecv() (*object.PutResponse, error)
}
PutObjectStream is an interface of NeoFS API v2 compatible client's object streamer.
type ResponseService ¶ added in v0.13.0
type ResponseService struct {
// contains filtered or unexported fields
}
func NewResponseService ¶
func NewResponseService(objSvc ServiceServer, respSvc *response.Service) *ResponseService
NewResponseService returns object service instance that passes internal service call to response service.
func (*ResponseService) Delete ¶ added in v0.13.0
func (s *ResponseService) Delete(ctx context.Context, req *object.DeleteRequest) (*object.DeleteResponse, error)
func (*ResponseService) Get ¶ added in v0.13.0
func (s *ResponseService) Get(req *object.GetRequest, stream GetObjectStream) error
func (*ResponseService) GetRange ¶ added in v0.13.0
func (s *ResponseService) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
func (*ResponseService) GetRangeHash ¶ added in v0.13.0
func (s *ResponseService) GetRangeHash(ctx context.Context, req *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
func (*ResponseService) Head ¶ added in v0.13.0
func (s *ResponseService) Head(ctx context.Context, req *object.HeadRequest) (*object.HeadResponse, error)
func (*ResponseService) Put ¶ added in v0.13.0
func (s *ResponseService) Put(ctx context.Context) (PutObjectStream, error)
func (*ResponseService) Search ¶ added in v0.13.0
func (s *ResponseService) Search(req *object.SearchRequest, stream SearchStream) error
type SearchStream ¶ added in v0.13.0
type SearchStream interface {
util.ServerStream
Send(*object.SearchResponse) error
}
SearchStream is an interface of NeoFS API v2 compatible search streamer.
type ServiceServer ¶ added in v0.13.0
type ServiceServer interface {
Get(*object.GetRequest, GetObjectStream) error
Put(context.Context) (PutObjectStream, error)
Head(context.Context, *object.HeadRequest) (*object.HeadResponse, error)
Search(*object.SearchRequest, SearchStream) error
Delete(context.Context, *object.DeleteRequest) (*object.DeleteResponse, error)
GetRange(*object.GetRangeRequest, GetObjectRangeStream) error
GetRangeHash(context.Context, *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
}
ServiceServer is an interface of utility serving v2 Object service.
type SignService ¶ added in v0.13.0
type SignService struct {
// contains filtered or unexported fields
}
func NewSignService ¶
func NewSignService(key *ecdsa.PrivateKey, svc ServiceServer) *SignService
func (*SignService) Delete ¶ added in v0.13.0
func (s *SignService) Delete(ctx context.Context, req *object.DeleteRequest) (*object.DeleteResponse, error)
func (*SignService) Get ¶ added in v0.13.0
func (s *SignService) Get(req *object.GetRequest, stream GetObjectStream) error
func (*SignService) GetRange ¶ added in v0.13.0
func (s *SignService) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
func (*SignService) GetRangeHash ¶ added in v0.13.0
func (s *SignService) GetRangeHash(ctx context.Context, req *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
func (*SignService) Head ¶ added in v0.13.0
func (s *SignService) Head(ctx context.Context, req *object.HeadRequest) (*object.HeadResponse, error)
func (*SignService) Put ¶ added in v0.13.0
func (s *SignService) Put(ctx context.Context) (PutObjectStream, error)
func (*SignService) Search ¶ added in v0.13.0
func (s *SignService) Search(req *object.SearchRequest, stream SearchStream) error
type TransportSplitter ¶
type TransportSplitter struct {
// contains filtered or unexported fields
}
func NewTransportSplitter ¶
func NewTransportSplitter(size, amount uint64, next ServiceServer) *TransportSplitter
func (TransportSplitter) Delete ¶
func (c TransportSplitter) Delete(ctx context.Context, request *object.DeleteRequest) (*object.DeleteResponse, error)
func (*TransportSplitter) Get ¶
func (c *TransportSplitter) Get(req *object.GetRequest, stream GetObjectStream) error
func (TransportSplitter) GetRange ¶
func (c TransportSplitter) GetRange(req *object.GetRangeRequest, stream GetObjectRangeStream) error
func (TransportSplitter) GetRangeHash ¶
func (c TransportSplitter) GetRangeHash(ctx context.Context, request *object.GetRangeHashRequest) (*object.GetRangeHashResponse, error)
func (TransportSplitter) Head ¶
func (c TransportSplitter) Head(ctx context.Context, request *object.HeadRequest) (*object.HeadResponse, error)
func (TransportSplitter) Put ¶
func (c TransportSplitter) Put(ctx context.Context) (PutObjectStream, error)
func (TransportSplitter) Search ¶
func (c TransportSplitter) Search(req *object.SearchRequest, stream SearchStream) error