Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterNotifierServer(s grpc.ServiceRegistrar, srv NotifierServer)
- type NotificationRequest
- func (*NotificationRequest) Descriptor() ([]byte, []int)deprecated
- func (x *NotificationRequest) GetTimeout() *durationpb.Duration
- func (x *NotificationRequest) GetTxStatusRequest() *TxStatusRequest
- func (*NotificationRequest) ProtoMessage()
- func (x *NotificationRequest) ProtoReflect() protoreflect.Message
- func (x *NotificationRequest) Reset()
- func (x *NotificationRequest) String() string
- type NotificationResponse
- func (*NotificationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *NotificationResponse) GetTimeoutTxIds() []string
- func (x *NotificationResponse) GetTxStatusEvents() []*TxStatusEvent
- func (*NotificationResponse) ProtoMessage()
- func (x *NotificationResponse) ProtoReflect() protoreflect.Message
- func (x *NotificationResponse) Reset()
- func (x *NotificationResponse) String() string
- type NotifierClient
- type NotifierServer
- type Notifier_OpenNotificationStreamClient
- type Notifier_OpenNotificationStreamServer
- type TxStatusEvent
- func (*TxStatusEvent) Descriptor() ([]byte, []int)deprecated
- func (x *TxStatusEvent) GetStatusWithHeight() *protoblocktx.StatusWithHeight
- func (x *TxStatusEvent) GetTxId() string
- func (*TxStatusEvent) ProtoMessage()
- func (x *TxStatusEvent) ProtoReflect() protoreflect.Message
- func (x *TxStatusEvent) Reset()
- func (x *TxStatusEvent) String() string
- type TxStatusRequest
- type UnimplementedNotifierServer
- type UnsafeNotifierServer
Constants ¶
const (
Notifier_OpenNotificationStream_FullMethodName = "/protonotify.Notifier/OpenNotificationStream"
)
Variables ¶
var File_api_protonotify_notify_proto protoreflect.FileDescriptor
var Notifier_ServiceDesc = grpc.ServiceDesc{ ServiceName: "protonotify.Notifier", HandlerType: (*NotifierServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "OpenNotificationStream", Handler: _Notifier_OpenNotificationStream_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "api/protonotify/notify.proto", }
Notifier_ServiceDesc is the grpc.ServiceDesc for Notifier service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterNotifierServer ¶
func RegisterNotifierServer(s grpc.ServiceRegistrar, srv NotifierServer)
Types ¶
type NotificationRequest ¶
type NotificationRequest struct {
TxStatusRequest *TxStatusRequest `protobuf:"bytes,1,opt,name=tx_status_request,json=txStatusRequest,proto3,oneof" json:"tx_status_request,omitempty"`
// The timeout duration that applies to ALL the subscriptions in this request.
// It is non-strict, i.e., it is possible to receive notifications for this request
// after the timeout has passed.
// If this field is not set or has a default value (zero), the default would be applied as
// per the committer's configuration.
Timeout *durationpb.Duration `protobuf:"bytes,2,opt,name=timeout,proto3" json:"timeout,omitempty"`
// contains filtered or unexported fields
}
NotificationRequest is sent by the clients to subscribe to events.
func (*NotificationRequest) Descriptor
deprecated
func (*NotificationRequest) Descriptor() ([]byte, []int)
Deprecated: Use NotificationRequest.ProtoReflect.Descriptor instead.
func (*NotificationRequest) GetTimeout ¶
func (x *NotificationRequest) GetTimeout() *durationpb.Duration
func (*NotificationRequest) GetTxStatusRequest ¶
func (x *NotificationRequest) GetTxStatusRequest() *TxStatusRequest
func (*NotificationRequest) ProtoMessage ¶
func (*NotificationRequest) ProtoMessage()
func (*NotificationRequest) ProtoReflect ¶
func (x *NotificationRequest) ProtoReflect() protoreflect.Message
func (*NotificationRequest) Reset ¶
func (x *NotificationRequest) Reset()
func (*NotificationRequest) String ¶
func (x *NotificationRequest) String() string
type NotificationResponse ¶
type NotificationResponse struct {
TxStatusEvents []*TxStatusEvent `protobuf:"bytes,1,rep,name=tx_status_events,json=txStatusEvents,proto3" json:"tx_status_events,omitempty"` // List of transaction status events.
TimeoutTxIds []string `protobuf:"bytes,2,rep,name=timeout_tx_ids,json=timeoutTxIds,proto3" json:"timeout_tx_ids,omitempty"` // List of timeout events.
// contains filtered or unexported fields
}
NotificationResponse contains a batch of event details. It is pushed to the client via the stream.
func (*NotificationResponse) Descriptor
deprecated
func (*NotificationResponse) Descriptor() ([]byte, []int)
Deprecated: Use NotificationResponse.ProtoReflect.Descriptor instead.
func (*NotificationResponse) GetTimeoutTxIds ¶
func (x *NotificationResponse) GetTimeoutTxIds() []string
func (*NotificationResponse) GetTxStatusEvents ¶
func (x *NotificationResponse) GetTxStatusEvents() []*TxStatusEvent
func (*NotificationResponse) ProtoMessage ¶
func (*NotificationResponse) ProtoMessage()
func (*NotificationResponse) ProtoReflect ¶
func (x *NotificationResponse) ProtoReflect() protoreflect.Message
func (*NotificationResponse) Reset ¶
func (x *NotificationResponse) Reset()
func (*NotificationResponse) String ¶
func (x *NotificationResponse) String() string
type NotifierClient ¶
type NotifierClient interface {
OpenNotificationStream(ctx context.Context, opts ...grpc.CallOption) (Notifier_OpenNotificationStreamClient, error)
}
NotifierClient is the client API for Notifier 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 NewNotifierClient ¶
func NewNotifierClient(cc grpc.ClientConnInterface) NotifierClient
type NotifierServer ¶
type NotifierServer interface {
OpenNotificationStream(Notifier_OpenNotificationStreamServer) error
// contains filtered or unexported methods
}
NotifierServer is the server API for Notifier service. All implementations must embed UnimplementedNotifierServer for forward compatibility
type Notifier_OpenNotificationStreamClient ¶
type Notifier_OpenNotificationStreamClient interface {
Send(*NotificationRequest) error
Recv() (*NotificationResponse, error)
grpc.ClientStream
}
type Notifier_OpenNotificationStreamServer ¶
type Notifier_OpenNotificationStreamServer interface {
Send(*NotificationResponse) error
Recv() (*NotificationRequest, error)
grpc.ServerStream
}
type TxStatusEvent ¶
type TxStatusEvent struct {
TxId string `protobuf:"bytes,1,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
StatusWithHeight *protoblocktx.StatusWithHeight `protobuf:"bytes,2,opt,name=status_with_height,json=statusWithHeight,proto3" json:"status_with_height,omitempty"`
// contains filtered or unexported fields
}
func (*TxStatusEvent) Descriptor
deprecated
func (*TxStatusEvent) Descriptor() ([]byte, []int)
Deprecated: Use TxStatusEvent.ProtoReflect.Descriptor instead.
func (*TxStatusEvent) GetStatusWithHeight ¶
func (x *TxStatusEvent) GetStatusWithHeight() *protoblocktx.StatusWithHeight
func (*TxStatusEvent) GetTxId ¶
func (x *TxStatusEvent) GetTxId() string
func (*TxStatusEvent) ProtoMessage ¶
func (*TxStatusEvent) ProtoMessage()
func (*TxStatusEvent) ProtoReflect ¶
func (x *TxStatusEvent) ProtoReflect() protoreflect.Message
func (*TxStatusEvent) Reset ¶
func (x *TxStatusEvent) Reset()
func (*TxStatusEvent) String ¶
func (x *TxStatusEvent) String() string
type TxStatusRequest ¶
type TxStatusRequest struct {
TxIds []string `protobuf:"bytes,1,rep,name=tx_ids,json=txIds,proto3" json:"tx_ids,omitempty"` // List of transaction IDS to be registered.
// contains filtered or unexported fields
}
TxStatusRequest details subscription to transaction status event.
func (*TxStatusRequest) Descriptor
deprecated
func (*TxStatusRequest) Descriptor() ([]byte, []int)
Deprecated: Use TxStatusRequest.ProtoReflect.Descriptor instead.
func (*TxStatusRequest) GetTxIds ¶
func (x *TxStatusRequest) GetTxIds() []string
func (*TxStatusRequest) ProtoMessage ¶
func (*TxStatusRequest) ProtoMessage()
func (*TxStatusRequest) ProtoReflect ¶
func (x *TxStatusRequest) ProtoReflect() protoreflect.Message
func (*TxStatusRequest) Reset ¶
func (x *TxStatusRequest) Reset()
func (*TxStatusRequest) String ¶
func (x *TxStatusRequest) String() string
type UnimplementedNotifierServer ¶
type UnimplementedNotifierServer struct {
}
UnimplementedNotifierServer must be embedded to have forward compatible implementations.
func (UnimplementedNotifierServer) OpenNotificationStream ¶
func (UnimplementedNotifierServer) OpenNotificationStream(Notifier_OpenNotificationStreamServer) error
type UnsafeNotifierServer ¶
type UnsafeNotifierServer interface {
// contains filtered or unexported methods
}
UnsafeNotifierServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NotifierServer will result in compilation errors.