container

Documentation

Index

• Constants
• func ParseDeleteNotary(ne event.NotaryEvent) (event.Event, error)
• func ParseDeleteSuccess(e *state.ContainedNotificationEvent) (event.Event, error)
• func ParsePutNamedNotary(ne event.NotaryEvent) (event.Event, error)
• func ParsePutNotary(ne event.NotaryEvent) (event.Event, error)
• func ParsePutSuccess(e *state.ContainedNotificationEvent) (event.Event, error)
• func ParseStartEstimation(e *state.ContainedNotificationEvent) (event.Event, error)
• func ParseStopEstimation(e *state.ContainedNotificationEvent) (event.Event, error)
• type Delete
  • func (d Delete) ContainerID() []byte
  • func (Delete) MorphEvent()
  • func (d Delete) NotaryRequest() *payload.P2PNotaryRequest
  • func (d Delete) SessionToken() []byte
  • func (d Delete) Signature() []byte
• type DeleteSuccess
  • func (DeleteSuccess) MorphEvent()
• type Put
  • func (p Put) Container() []byte
  • func (Put) MorphEvent()
  • func (p Put) NotaryRequest() *payload.P2PNotaryRequest
  • func (p Put) PublicKey() []byte
  • func (p Put) SessionToken() []byte
  • func (p Put) Signature() []byte
• type PutNamed
  • func (x PutNamed) Name() string
  • func (x PutNamed) Zone() string
• type PutSuccess
  • func (PutSuccess) MorphEvent()
• type StartEstimation
  • func (s StartEstimation) Epoch() uint64
  • func (StartEstimation) MorphEvent()
• type StopEstimation
  • func (s StopEstimation) Epoch() uint64
  • func (StopEstimation) MorphEvent()

Constants

const (
	// PutNotaryEvent is method name for container put operations
	// in `Container` contract. Is used as identificator for notary
	// put container requests.
	PutNotaryEvent = "put"

	// PutNamedNotaryEvent is an ID of notary "put named container" notification.
	PutNamedNotaryEvent = "putNamed"
)

const (
	// DeleteNotaryEvent is method name for container delete operations
	// in `Container` contract. Is used as identificator for notary
	// delete container requests.
	DeleteNotaryEvent = "delete"
)

Functions

func ParseDeleteNotary

func ParseDeleteNotary(ne event.NotaryEvent) (event.Event, error)

ParseDeleteNotary from NotaryEvent into container event structure.

func ParseDeleteSuccess

func ParseDeleteSuccess(e *state.ContainedNotificationEvent) (event.Event, error)

ParseDeleteSuccess decodes notification event thrown by Container contract into DeleteSuccess and returns it as event.Event.

func ParsePutNamedNotary

func ParsePutNamedNotary(ne event.NotaryEvent) (event.Event, error)

ParsePutNamedNotary parses PutNamed event structure from generic event.NotaryEvent.

func ParsePutNotary

func ParsePutNotary(ne event.NotaryEvent) (event.Event, error)

ParsePutNotary from NotaryEvent into container event structure.

func ParsePutSuccess

func ParsePutSuccess(e *state.ContainedNotificationEvent) (event.Event, error)

ParsePutSuccess decodes notification event thrown by Container contract into PutSuccess and returns it as event.Event.

func ParseStartEstimation

func ParseStartEstimation(e *state.ContainedNotificationEvent) (event.Event, error)

ParseStartEstimation from notification into container event structure.

func ParseStopEstimation

func ParseStopEstimation(e *state.ContainedNotificationEvent) (event.Event, error)

ParseStopEstimation from notification into container event structure.

Types

type Delete

type Delete struct {
	ContainerIDValue []byte
	SignatureValue   []byte
	TokenValue       []byte
	PublicKeyValue   []byte

	// For notary notifications only.
	// Contains raw transactions of notary request.
	NotaryRequestValue *payload.P2PNotaryRequest
}

Delete structure of container.Delete notification from morph chain.

func (Delete) ContainerID

func (d Delete) ContainerID() []byte

ContainerID is a marshalled container structure, defined in API.

func (Delete) MorphEvent

func (Delete) MorphEvent()

MorphEvent implements Neo:Morph Event interface.

func (Delete) NotaryRequest

func (d Delete) NotaryRequest() *payload.P2PNotaryRequest

NotaryRequest returns raw notary request if notification was received via notary service. Otherwise, returns nil.

func (Delete) SessionToken

func (d Delete) SessionToken() []byte

SessionToken returns binary token of the session within which the eACL was set.

func (Delete) Signature

func (d Delete) Signature() []byte

Signature of marshalled container by container owner.

type DeleteSuccess

type DeleteSuccess struct {
	// Identifier of the removed container.
	ID cid.ID
}

DeleteSuccess structures notification event of successful container removal thrown by Container contract.

func (DeleteSuccess) MorphEvent

func (DeleteSuccess) MorphEvent()

MorphEvent implements Neo:Morph Event interface.

type Put

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

Put structure of container.Put notification from morph chain.

func (Put) Container

func (p Put) Container() []byte

Container is a marshalled container structure, defined in API.

func (Put) MorphEvent

func (Put) MorphEvent()

MorphEvent implements Neo:Morph Event interface.

func (Put) NotaryRequest

func (p Put) NotaryRequest() *payload.P2PNotaryRequest

NotaryRequest returns raw notary request if notification was received via notary service. Otherwise, returns nil.

func (Put) PublicKey

func (p Put) PublicKey() []byte

PublicKey of container owner.

func (Put) SessionToken

func (p Put) SessionToken() []byte

SessionToken returns binary token of the session within which the container was created.

func (Put) Signature

func (p Put) Signature() []byte

Signature of marshalled container by container owner.

type PutNamed

type PutNamed struct {
	Put
	// contains filtered or unexported fields
}

PutNamed represents notification event spawned by PutNamed method from Container contract of FrostFS Morph chain.

func (PutNamed) Name

func (x PutNamed) Name() string

Name returns "name" arg of contract call.

func (PutNamed) Zone

func (x PutNamed) Zone() string

Zone returns "zone" arg of contract call.

type PutSuccess

type PutSuccess struct {
	// Identifier of the newly created container.
	ID cid.ID
}

PutSuccess structures notification event of successful container creation thrown by Container contract.

func (PutSuccess) MorphEvent

func (PutSuccess) MorphEvent()

MorphEvent implements Neo:Morph Event interface.

type StartEstimation

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

StartEstimation structure of container.StartEstimation notification from morph chain.

func (StartEstimation) Epoch

func (s StartEstimation) Epoch() uint64

Epoch returns epoch value for which to start container size estimation.

func (StartEstimation) MorphEvent

func (StartEstimation) MorphEvent()

MorphEvent implements Neo:Morph Event interface.

type StopEstimation

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

StopEstimation structure of container.StopEstimation notification from morph chain.

func (StopEstimation) Epoch

func (s StopEstimation) Epoch() uint64

Epoch returns epoch value for which to stop container size estimation.

func (StopEstimation) MorphEvent

func (StopEstimation) MorphEvent()

MorphEvent implements Neo:Morph Event interface.