Documentation
¶
Overview ¶
Package celerx_fee_interface is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterOspSubscriberHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterOspSubscriberHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OspSubscriberClient) error
- func RegisterOspSubscriberHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterOspSubscriberHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OspSubscriberServer) error
- func RegisterOspSubscriberServer(s *grpc.Server, srv OspSubscriberServer)
- type FeeEvent
- func (*FeeEvent) Descriptor() ([]byte, []int)deprecated
- func (x *FeeEvent) GetNote() *anypb.Anydeprecated
- func (x *FeeEvent) GetNotePbString() string
- func (x *FeeEvent) GetPay() *entity.ConditionalPay
- func (x *FeeEvent) GetPayId() []byte
- func (x *FeeEvent) GetSendSuccess() bool
- func (*FeeEvent) ProtoMessage()
- func (x *FeeEvent) ProtoReflect() protoreflect.Message
- func (x *FeeEvent) Reset()
- func (x *FeeEvent) String() string
- type NewHopStreamEvent
- type OspSubscriberClient
- type OspSubscriberServer
- type UnimplementedOspSubscriberServer
- func (UnimplementedOspSubscriberServer) NotifyFeeReceived(context.Context, *FeeEvent) (*emptypb.Empty, error)
- func (UnimplementedOspSubscriberServer) NotifyFeeSendComplete(context.Context, *FeeEvent) (*emptypb.Empty, error)
- func (UnimplementedOspSubscriberServer) NotifyNewStream(context.Context, *NewHopStreamEvent) (*emptypb.Empty, error)
- type UnsafeOspSubscriberServer
Constants ¶
This section is empty.
Variables ¶
var File_fee_proto protoreflect.FileDescriptor
Functions ¶
func RegisterOspSubscriberHandler ¶
func RegisterOspSubscriberHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterOspSubscriberHandler registers the http handlers for service OspSubscriber to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterOspSubscriberHandlerClient ¶
func RegisterOspSubscriberHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OspSubscriberClient) error
RegisterOspSubscriberHandlerClient registers the http handlers for service OspSubscriber to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "OspSubscriberClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "OspSubscriberClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "OspSubscriberClient" to call the correct interceptors.
func RegisterOspSubscriberHandlerFromEndpoint ¶
func RegisterOspSubscriberHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterOspSubscriberHandlerFromEndpoint is same as RegisterOspSubscriberHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterOspSubscriberHandlerServer ¶
func RegisterOspSubscriberHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OspSubscriberServer) error
RegisterOspSubscriberHandlerServer registers the http handlers for service OspSubscriber to "mux". UnaryRPC :call OspSubscriberServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906.
func RegisterOspSubscriberServer ¶
func RegisterOspSubscriberServer(s *grpc.Server, srv OspSubscriberServer)
Types ¶
type FeeEvent ¶
type FeeEvent struct {
Pay *entity.ConditionalPay `protobuf:"bytes,1,opt,name=pay,proto3" json:"pay,omitempty"`
// Deprecated: Marked as deprecated in fee.proto.
Note *anypb.Any `protobuf:"bytes,2,opt,name=note,proto3" json:"note,omitempty"`
SendSuccess bool `protobuf:"varint,3,opt,name=send_success,json=sendSuccess,proto3" json:"send_success,omitempty"`
PayId []byte `protobuf:"bytes,4,opt,name=pay_id,json=payId,proto3" json:"pay_id,omitempty"`
NotePbString string `protobuf:"bytes,5,opt,name=note_pb_string,json=notePbString,proto3" json:"note_pb_string,omitempty"`
// contains filtered or unexported fields
}
FeeEvent to be renamed to PayEvent to be use-case neutral and to be moved to proto repo. This message is now the API osp published for pay event. Next Tag: 6
func (*FeeEvent) Descriptor
deprecated
func (*FeeEvent) GetNotePbString ¶
func (*FeeEvent) GetPay ¶
func (x *FeeEvent) GetPay() *entity.ConditionalPay
func (*FeeEvent) GetSendSuccess ¶
func (*FeeEvent) ProtoMessage ¶
func (*FeeEvent) ProtoMessage()
func (*FeeEvent) ProtoReflect ¶ added in v1.1.0
func (x *FeeEvent) ProtoReflect() protoreflect.Message
type NewHopStreamEvent ¶
type NewHopStreamEvent struct {
Addr string `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
// contains filtered or unexported fields
}
--------------------------- OSP-facing service ----------------------------- Next Tag: 2
func (*NewHopStreamEvent) Descriptor
deprecated
func (*NewHopStreamEvent) Descriptor() ([]byte, []int)
Deprecated: Use NewHopStreamEvent.ProtoReflect.Descriptor instead.
func (*NewHopStreamEvent) GetAddr ¶
func (x *NewHopStreamEvent) GetAddr() string
func (*NewHopStreamEvent) ProtoMessage ¶
func (*NewHopStreamEvent) ProtoMessage()
func (*NewHopStreamEvent) ProtoReflect ¶ added in v1.1.0
func (x *NewHopStreamEvent) ProtoReflect() protoreflect.Message
func (*NewHopStreamEvent) Reset ¶
func (x *NewHopStreamEvent) Reset()
func (*NewHopStreamEvent) String ¶
func (x *NewHopStreamEvent) String() string
type OspSubscriberClient ¶
type OspSubscriberClient interface {
NotifyNewStream(ctx context.Context, in *NewHopStreamEvent, opts ...grpc.CallOption) (*emptypb.Empty, error)
NotifyFeeReceived(ctx context.Context, in *FeeEvent, opts ...grpc.CallOption) (*emptypb.Empty, error)
NotifyFeeSendComplete(ctx context.Context, in *FeeEvent, opts ...grpc.CallOption) (*emptypb.Empty, error)
}
OspSubscriberClient is the client API for OspSubscriber 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 NewOspSubscriberClient ¶
func NewOspSubscriberClient(cc grpc.ClientConnInterface) OspSubscriberClient
type OspSubscriberServer ¶
type OspSubscriberServer interface {
NotifyNewStream(context.Context, *NewHopStreamEvent) (*emptypb.Empty, error)
NotifyFeeReceived(context.Context, *FeeEvent) (*emptypb.Empty, error)
NotifyFeeSendComplete(context.Context, *FeeEvent) (*emptypb.Empty, error)
}
OspSubscriberServer is the server API for OspSubscriber service. All implementations should embed UnimplementedOspSubscriberServer for forward compatibility
type UnimplementedOspSubscriberServer ¶ added in v1.1.0
type UnimplementedOspSubscriberServer struct {
}
UnimplementedOspSubscriberServer should be embedded to have forward compatible implementations.
func (UnimplementedOspSubscriberServer) NotifyFeeReceived ¶ added in v1.1.0
func (UnimplementedOspSubscriberServer) NotifyFeeSendComplete ¶ added in v1.1.0
func (UnimplementedOspSubscriberServer) NotifyNewStream ¶ added in v1.1.0
func (UnimplementedOspSubscriberServer) NotifyNewStream(context.Context, *NewHopStreamEvent) (*emptypb.Empty, error)
type UnsafeOspSubscriberServer ¶ added in v1.1.0
type UnsafeOspSubscriberServer interface {
// contains filtered or unexported methods
}
UnsafeOspSubscriberServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to OspSubscriberServer will result in compilation errors.
Source Files