mirror

package
v2.51.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ConsensusService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.hedera.mirror.api.proto.ConsensusService",
	HandlerType: (*ConsensusServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "subscribeTopic",
			Handler:       _ConsensusService_SubscribeTopic_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "mirror/consensus_service.proto",
}

ConsensusService_ServiceDesc is the grpc.ServiceDesc for ConsensusService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_mirror_consensus_service_proto protoreflect.FileDescriptor
View Source 
var File_mirror_mirror_network_service_proto protoreflect.FileDescriptor
View Source 
var NetworkService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "com.hedera.mirror.api.proto.NetworkService",
	HandlerType: (*NetworkServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "getNodes",
			Handler:       _NetworkService_GetNodes_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "mirror/mirror_network_service.proto",
}

NetworkService_ServiceDesc is the grpc.ServiceDesc for NetworkService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterConsensusServiceServer 

func RegisterConsensusServiceServer(s grpc.ServiceRegistrar, srv ConsensusServiceServer)

func RegisterNetworkServiceServer added in v2.49.0 

func RegisterNetworkServiceServer(s grpc.ServiceRegistrar, srv NetworkServiceServer)

Types

type AddressBookQuery added in v2.49.0 

type AddressBookQuery struct {

	// *
	// The ID of the address book file on the network. Can be either 0.0.101 or 0.0.102.
	FileId *services.FileID `protobuf:"bytes,1,opt,name=file_id,json=fileId,proto3" json:"file_id,omitempty"`
	// *
	// The maximum number of node addresses to receive before stopping. If not set or set to zero it will return all node addresses in the database.
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

* Request object to query an address book for its list of nodes

func (*AddressBookQuery) Descriptor deprecated added in v2.49.0 

func (*AddressBookQuery) Descriptor() ([]byte, []int)

Deprecated: Use AddressBookQuery.ProtoReflect.Descriptor instead.

func (*AddressBookQuery) GetFileId added in v2.49.0 

func (x *AddressBookQuery) GetFileId() *services.FileID

func (*AddressBookQuery) GetLimit added in v2.49.0 

func (x *AddressBookQuery) GetLimit() int32

func (*AddressBookQuery) ProtoMessage added in v2.49.0 

func (*AddressBookQuery) ProtoMessage()

func (*AddressBookQuery) ProtoReflect added in v2.49.0 

func (x *AddressBookQuery) ProtoReflect() protoreflect.Message

func (*AddressBookQuery) Reset added in v2.49.0 

func (x *AddressBookQuery) Reset()

func (*AddressBookQuery) String added in v2.49.0 

func (x *AddressBookQuery) String() string

type ConsensusServiceClient 

type ConsensusServiceClient interface {
	SubscribeTopic(ctx context.Context, in *ConsensusTopicQuery, opts ...grpc.CallOption) (ConsensusService_SubscribeTopicClient, error)
}

ConsensusServiceClient is the client API for ConsensusService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewConsensusServiceClient 

func NewConsensusServiceClient(cc grpc.ClientConnInterface) ConsensusServiceClient

type ConsensusServiceServer 

type ConsensusServiceServer interface {
	SubscribeTopic(*ConsensusTopicQuery, ConsensusService_SubscribeTopicServer) error
	// contains filtered or unexported methods
}

ConsensusServiceServer is the server API for ConsensusService service. All implementations must embed UnimplementedConsensusServiceServer for forward compatibility

type ConsensusService_SubscribeTopicClient 

type ConsensusService_SubscribeTopicClient interface {
	Recv() (*ConsensusTopicResponse, error)
	grpc.ClientStream
}

type ConsensusService_SubscribeTopicServer 

type ConsensusService_SubscribeTopicServer interface {
	Send(*ConsensusTopicResponse) error
	grpc.ServerStream
}

type ConsensusTopicQuery 

type ConsensusTopicQuery struct {

	// *
	// A required topic ID to retrieve messages for.
	TopicID *services.TopicID `protobuf:"bytes,1,opt,name=topicID,proto3" json:"topicID,omitempty"`
	// *
	// Include messages which reached consensus on or after this time. Defaults to current time if
	// not set.
	ConsensusStartTime *services.Timestamp `protobuf:"bytes,2,opt,name=consensusStartTime,proto3" json:"consensusStartTime,omitempty"`
	// *
	// Include messages which reached consensus before this time. If not set it will receive
	// indefinitely.
	ConsensusEndTime *services.Timestamp `protobuf:"bytes,3,opt,name=consensusEndTime,proto3" json:"consensusEndTime,omitempty"`
	// *
	// The maximum number of messages to receive before stopping. If not set or set to zero it will
	// return messages indefinitely.
	Limit uint64 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*ConsensusTopicQuery) Descriptor deprecated 

func (*ConsensusTopicQuery) Descriptor() ([]byte, []int)

Deprecated: Use ConsensusTopicQuery.ProtoReflect.Descriptor instead.

func (*ConsensusTopicQuery) GetConsensusEndTime 

func (x *ConsensusTopicQuery) GetConsensusEndTime() *services.Timestamp

func (*ConsensusTopicQuery) GetConsensusStartTime 

func (x *ConsensusTopicQuery) GetConsensusStartTime() *services.Timestamp

func (*ConsensusTopicQuery) GetLimit 

func (x *ConsensusTopicQuery) GetLimit() uint64

func (*ConsensusTopicQuery) GetTopicID 

func (x *ConsensusTopicQuery) GetTopicID() *services.TopicID

func (*ConsensusTopicQuery) ProtoMessage 

func (*ConsensusTopicQuery) ProtoMessage()

func (*ConsensusTopicQuery) ProtoReflect 

func (x *ConsensusTopicQuery) ProtoReflect() protoreflect.Message

func (*ConsensusTopicQuery) Reset 

func (x *ConsensusTopicQuery) Reset()

func (*ConsensusTopicQuery) String 

func (x *ConsensusTopicQuery) String() string

type ConsensusTopicResponse 

type ConsensusTopicResponse struct {

	// *
	// The time at which the transaction reached consensus
	ConsensusTimestamp *services.Timestamp `protobuf:"bytes,1,opt,name=consensusTimestamp,proto3" json:"consensusTimestamp,omitempty"`
	// *
	// The message body originally in the ConsensusSubmitMessageTransactionBody. Message size will
	// be less than 6KiB.
	Message []byte `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// *
	// The running hash (SHA384) of every message.
	RunningHash []byte `protobuf:"bytes,3,opt,name=runningHash,proto3" json:"runningHash,omitempty"`
	// *
	// Starts at 1 for first submitted message. Incremented on each submitted message.
	SequenceNumber uint64 `protobuf:"varint,4,opt,name=sequenceNumber,proto3" json:"sequenceNumber,omitempty"`
	// *
	// Version of the SHA-384 digest used to update the running hash.
	RunningHashVersion uint64 `protobuf:"varint,5,opt,name=runningHashVersion,proto3" json:"runningHashVersion,omitempty"`
	// *
	// Optional information of the current chunk in a fragmented message.
	ChunkInfo *services.ConsensusMessageChunkInfo `protobuf:"bytes,6,opt,name=chunkInfo,proto3" json:"chunkInfo,omitempty"`
	// contains filtered or unexported fields
}

func (*ConsensusTopicResponse) Descriptor deprecated 

func (*ConsensusTopicResponse) Descriptor() ([]byte, []int)

Deprecated: Use ConsensusTopicResponse.ProtoReflect.Descriptor instead.

func (*ConsensusTopicResponse) GetChunkInfo 

func (x *ConsensusTopicResponse) GetChunkInfo() *services.ConsensusMessageChunkInfo

func (*ConsensusTopicResponse) GetConsensusTimestamp 

func (x *ConsensusTopicResponse) GetConsensusTimestamp() *services.Timestamp

func (*ConsensusTopicResponse) GetMessage 

func (x *ConsensusTopicResponse) GetMessage() []byte

func (*ConsensusTopicResponse) GetRunningHash 

func (x *ConsensusTopicResponse) GetRunningHash() []byte

func (*ConsensusTopicResponse) GetRunningHashVersion 

func (x *ConsensusTopicResponse) GetRunningHashVersion() uint64

func (*ConsensusTopicResponse) GetSequenceNumber 

func (x *ConsensusTopicResponse) GetSequenceNumber() uint64

func (*ConsensusTopicResponse) ProtoMessage 

func (*ConsensusTopicResponse) ProtoMessage()

func (*ConsensusTopicResponse) ProtoReflect 

func (x *ConsensusTopicResponse) ProtoReflect() protoreflect.Message

func (*ConsensusTopicResponse) Reset 

func (x *ConsensusTopicResponse) Reset()

func (*ConsensusTopicResponse) String 

func (x *ConsensusTopicResponse) String() string

type NetworkServiceClient added in v2.49.0 

type NetworkServiceClient interface {
	// Query for an address book and return its nodes. The nodes are returned in ascending order by node ID. The
	// response is not guaranteed to be a byte-for-byte equivalent to the NodeAddress in the Hedera file on
	// the network since it is reconstructed from a normalized database table.
	GetNodes(ctx context.Context, in *AddressBookQuery, opts ...grpc.CallOption) (NetworkService_GetNodesClient, error)
}

NetworkServiceClient is the client API for NetworkService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewNetworkServiceClient added in v2.49.0 

func NewNetworkServiceClient(cc grpc.ClientConnInterface) NetworkServiceClient

type NetworkServiceServer added in v2.49.0 

type NetworkServiceServer interface {
	// Query for an address book and return its nodes. The nodes are returned in ascending order by node ID. The
	// response is not guaranteed to be a byte-for-byte equivalent to the NodeAddress in the Hedera file on
	// the network since it is reconstructed from a normalized database table.
	GetNodes(*AddressBookQuery, NetworkService_GetNodesServer) error
	// contains filtered or unexported methods
}

NetworkServiceServer is the server API for NetworkService service. All implementations must embed UnimplementedNetworkServiceServer for forward compatibility

type NetworkService_GetNodesClient added in v2.49.0 

type NetworkService_GetNodesClient interface {
	Recv() (*services.NodeAddress, error)
	grpc.ClientStream
}

type NetworkService_GetNodesServer added in v2.49.0 

type NetworkService_GetNodesServer interface {
	Send(*services.NodeAddress) error
	grpc.ServerStream
}

type UnimplementedConsensusServiceServer 

type UnimplementedConsensusServiceServer struct {
}

UnimplementedConsensusServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedConsensusServiceServer) SubscribeTopic 

func (UnimplementedConsensusServiceServer) SubscribeTopic(*ConsensusTopicQuery, ConsensusService_SubscribeTopicServer) error

type UnimplementedNetworkServiceServer added in v2.49.0 

type UnimplementedNetworkServiceServer struct {
}

UnimplementedNetworkServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedNetworkServiceServer) GetNodes added in v2.49.0 

func (UnimplementedNetworkServiceServer) GetNodes(*AddressBookQuery, NetworkService_GetNodesServer) error

type UnsafeConsensusServiceServer added in v2.1.11 

type UnsafeConsensusServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeConsensusServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ConsensusServiceServer will result in compilation errors.

type UnsafeNetworkServiceServer added in v2.49.0 

type UnsafeNetworkServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeNetworkServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NetworkServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.