Documentation ¶
Index ¶
- Variables
- type EchoModuleParams
- type Factory
- func (*Factory) Descriptor() ([]byte, []int)deprecated
- func (x *Factory) GetGarbageCollect() *GarbageCollect
- func (x *Factory) GetNewModule() *NewModule
- func (m *Factory) GetType() isFactory_Type
- func (*Factory) ProtoMessage()
- func (x *Factory) ProtoReflect() protoreflect.Message
- func (*Factory) ReflectTypeOptions() []reflect.Type
- func (x *Factory) Reset()
- func (x *Factory) String() string
- type Factory_GarbageCollect
- type Factory_NewModule
- type Factory_Type
- type Factory_TypeWrapper
- type GarbageCollect
- type GeneratorParams
- func (*GeneratorParams) Descriptor() ([]byte, []int)deprecated
- func (x *GeneratorParams) GetCheckpoint() *checkpointpb.InstanceParams
- func (x *GeneratorParams) GetEchoTestModule() *EchoModuleParams
- func (x *GeneratorParams) GetMultisigCollector() *mscpb.InstanceParams
- func (x *GeneratorParams) GetPbftModule() *ordererspb.PBFTModule
- func (m *GeneratorParams) GetType() isGeneratorParams_Type
- func (*GeneratorParams) ProtoMessage()
- func (x *GeneratorParams) ProtoReflect() protoreflect.Message
- func (*GeneratorParams) ReflectTypeOptions() []reflect.Type
- func (x *GeneratorParams) Reset()
- func (x *GeneratorParams) String() string
- type GeneratorParams_Checkpoint
- type GeneratorParams_EchoTestModule
- type GeneratorParams_MultisigCollector
- type GeneratorParams_PbftModule
- type GeneratorParams_Type
- type GeneratorParams_TypeWrapper
- type NewModule
- func (*NewModule) Descriptor() ([]byte, []int)deprecated
- func (x *NewModule) GetModuleId() string
- func (x *NewModule) GetParams() *GeneratorParams
- func (x *NewModule) GetRetentionIndex() uint64
- func (*NewModule) ProtoMessage()
- func (x *NewModule) ProtoReflect() protoreflect.Message
- func (x *NewModule) Reset()
- func (x *NewModule) String() string
Constants ¶
This section is empty.
Variables ¶
var File_factorymodulepb_factorymodulepb_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type EchoModuleParams ¶
type EchoModuleParams struct { Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"` // This prefix is prepended to all strings the module echoes. // contains filtered or unexported fields }
Used only for unit tests.
func (*EchoModuleParams) Descriptor
deprecated
func (*EchoModuleParams) Descriptor() ([]byte, []int)
Deprecated: Use EchoModuleParams.ProtoReflect.Descriptor instead.
func (*EchoModuleParams) GetPrefix ¶
func (x *EchoModuleParams) GetPrefix() string
func (*EchoModuleParams) ProtoMessage ¶
func (*EchoModuleParams) ProtoMessage()
func (*EchoModuleParams) ProtoReflect ¶
func (x *EchoModuleParams) ProtoReflect() protoreflect.Message
func (*EchoModuleParams) Reset ¶
func (x *EchoModuleParams) Reset()
func (*EchoModuleParams) String ¶
func (x *EchoModuleParams) String() string
type Factory ¶
type Factory struct { // Types that are assignable to Type: // *Factory_NewModule // *Factory_GarbageCollect Type isFactory_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
FIXME: rename to Event to be consistent with other modules and avoid repeating the package name.
func (*Factory) Descriptor
deprecated
func (*Factory) GetGarbageCollect ¶
func (x *Factory) GetGarbageCollect() *GarbageCollect
func (*Factory) GetNewModule ¶
func (*Factory) ProtoMessage ¶
func (*Factory) ProtoMessage()
func (*Factory) ProtoReflect ¶
func (x *Factory) ProtoReflect() protoreflect.Message
func (*Factory) ReflectTypeOptions ¶ added in v0.3.5
type Factory_GarbageCollect ¶
type Factory_GarbageCollect struct {
GarbageCollect *GarbageCollect `protobuf:"bytes,2,opt,name=garbage_collect,json=garbageCollect,proto3,oneof"`
}
func (*Factory_GarbageCollect) Unwrap ¶ added in v0.3.5
func (w *Factory_GarbageCollect) Unwrap() *GarbageCollect
type Factory_NewModule ¶
type Factory_NewModule struct {
NewModule *NewModule `protobuf:"bytes,1,opt,name=new_module,json=newModule,proto3,oneof"`
}
func (*Factory_NewModule) Unwrap ¶ added in v0.3.5
func (w *Factory_NewModule) Unwrap() *NewModule
type Factory_Type ¶ added in v0.3.5
type Factory_Type = isFactory_Type
type Factory_TypeWrapper ¶ added in v0.3.5
type Factory_TypeWrapper[T any] interface { Factory_Type Unwrap() *T }
type GarbageCollect ¶
type GarbageCollect struct { RetentionIndex uint64 `protobuf:"varint,1,opt,name=retention_index,json=retentionIndex,proto3" json:"retention_index,omitempty"` // contains filtered or unexported fields }
GarbageCollect is a request to destroy all modules that have retention index smaller than the given index.
func (*GarbageCollect) Descriptor
deprecated
func (*GarbageCollect) Descriptor() ([]byte, []int)
Deprecated: Use GarbageCollect.ProtoReflect.Descriptor instead.
func (*GarbageCollect) GetRetentionIndex ¶
func (x *GarbageCollect) GetRetentionIndex() uint64
func (*GarbageCollect) ProtoMessage ¶
func (*GarbageCollect) ProtoMessage()
func (*GarbageCollect) ProtoReflect ¶
func (x *GarbageCollect) ProtoReflect() protoreflect.Message
func (*GarbageCollect) Reset ¶
func (x *GarbageCollect) Reset()
func (*GarbageCollect) String ¶
func (x *GarbageCollect) String() string
type GeneratorParams ¶
type GeneratorParams struct { // Types that are assignable to Type: // *GeneratorParams_MultisigCollector // *GeneratorParams_Checkpoint // *GeneratorParams_EchoTestModule // *GeneratorParams_PbftModule Type isGeneratorParams_Type `protobuf_oneof:"type"` // contains filtered or unexported fields }
GeneratorParams is a union of all possible types of module parameters for modules that can be created by the factory module.
func (*GeneratorParams) Descriptor
deprecated
func (*GeneratorParams) Descriptor() ([]byte, []int)
Deprecated: Use GeneratorParams.ProtoReflect.Descriptor instead.
func (*GeneratorParams) GetCheckpoint ¶
func (x *GeneratorParams) GetCheckpoint() *checkpointpb.InstanceParams
func (*GeneratorParams) GetEchoTestModule ¶
func (x *GeneratorParams) GetEchoTestModule() *EchoModuleParams
func (*GeneratorParams) GetMultisigCollector ¶
func (x *GeneratorParams) GetMultisigCollector() *mscpb.InstanceParams
func (*GeneratorParams) GetPbftModule ¶ added in v0.2.0
func (x *GeneratorParams) GetPbftModule() *ordererspb.PBFTModule
func (*GeneratorParams) GetType ¶
func (m *GeneratorParams) GetType() isGeneratorParams_Type
func (*GeneratorParams) ProtoMessage ¶
func (*GeneratorParams) ProtoMessage()
func (*GeneratorParams) ProtoReflect ¶
func (x *GeneratorParams) ProtoReflect() protoreflect.Message
func (*GeneratorParams) ReflectTypeOptions ¶ added in v0.3.5
func (*GeneratorParams) ReflectTypeOptions() []reflect.Type
func (*GeneratorParams) Reset ¶
func (x *GeneratorParams) Reset()
func (*GeneratorParams) String ¶
func (x *GeneratorParams) String() string
type GeneratorParams_Checkpoint ¶
type GeneratorParams_Checkpoint struct {
Checkpoint *checkpointpb.InstanceParams `protobuf:"bytes,2,opt,name=checkpoint,proto3,oneof"`
}
func (*GeneratorParams_Checkpoint) Unwrap ¶ added in v0.3.5
func (w *GeneratorParams_Checkpoint) Unwrap() *checkpointpb.InstanceParams
type GeneratorParams_EchoTestModule ¶
type GeneratorParams_EchoTestModule struct {
EchoTestModule *EchoModuleParams `protobuf:"bytes,3,opt,name=echo_test_module,json=echoTestModule,proto3,oneof"`
}
func (*GeneratorParams_EchoTestModule) Unwrap ¶ added in v0.3.5
func (w *GeneratorParams_EchoTestModule) Unwrap() *EchoModuleParams
type GeneratorParams_MultisigCollector ¶
type GeneratorParams_MultisigCollector struct {
MultisigCollector *mscpb.InstanceParams `protobuf:"bytes,1,opt,name=multisig_collector,json=multisigCollector,proto3,oneof"`
}
func (*GeneratorParams_MultisigCollector) Unwrap ¶ added in v0.3.5
func (w *GeneratorParams_MultisigCollector) Unwrap() *mscpb.InstanceParams
type GeneratorParams_PbftModule ¶ added in v0.2.0
type GeneratorParams_PbftModule struct {
PbftModule *ordererspb.PBFTModule `protobuf:"bytes,4,opt,name=pbft_module,json=pbftModule,proto3,oneof"`
}
func (*GeneratorParams_PbftModule) Unwrap ¶ added in v0.3.5
func (w *GeneratorParams_PbftModule) Unwrap() *ordererspb.PBFTModule
type GeneratorParams_Type ¶ added in v0.3.5
type GeneratorParams_Type = isGeneratorParams_Type
type GeneratorParams_TypeWrapper ¶ added in v0.3.5
type GeneratorParams_TypeWrapper[T any] interface { GeneratorParams_Type Unwrap() *T }
type NewModule ¶
type NewModule struct { ModuleId string `protobuf:"bytes,1,opt,name=module_id,json=moduleId,proto3" json:"module_id,omitempty"` RetentionIndex uint64 `protobuf:"varint,2,opt,name=retention_index,json=retentionIndex,proto3" json:"retention_index,omitempty"` Params *GeneratorParams `protobuf:"bytes,3,opt,name=params,proto3" json:"params,omitempty"` // contains filtered or unexported fields }
NewModule is a request to create a new module. module_id must be prefixed with the factory module's ID followed by "/". retention_index is used for garbage collection (see: GarbageCollect).
func (*NewModule) Descriptor
deprecated
func (*NewModule) GetModuleId ¶
func (*NewModule) GetParams ¶
func (x *NewModule) GetParams() *GeneratorParams
func (*NewModule) GetRetentionIndex ¶
func (*NewModule) ProtoMessage ¶
func (*NewModule) ProtoMessage()
func (*NewModule) ProtoReflect ¶
func (x *NewModule) ProtoReflect() protoreflect.Message