payer_api

Documentation

Overview

Package payer_api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Constants
• Variables
• func RegisterPayerApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterPayerApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client PayerApiClient) error
• func RegisterPayerApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterPayerApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server PayerApiServer) error
• func RegisterPayerApiServer(s grpc.ServiceRegistrar, srv PayerApiServer)
• type PayerApiClient
  • func NewPayerApiClient(cc grpc.ClientConnInterface) PayerApiClient
• type PayerApiServer
• type PublishClientEnvelopesRequest
  • func (*PublishClientEnvelopesRequest) Descriptor() ([]byte, []int)
  • func (x *PublishClientEnvelopesRequest) GetEnvelopes() []*envelopes.ClientEnvelope
  • func (*PublishClientEnvelopesRequest) ProtoMessage()
  • func (x *PublishClientEnvelopesRequest) ProtoReflect() protoreflect.Message
  • func (x *PublishClientEnvelopesRequest) Reset()
  • func (x *PublishClientEnvelopesRequest) String() string
• type PublishClientEnvelopesResponse
  • func (*PublishClientEnvelopesResponse) Descriptor() ([]byte, []int)
  • func (x *PublishClientEnvelopesResponse) GetOriginatorEnvelopes() []*envelopes.OriginatorEnvelope
  • func (*PublishClientEnvelopesResponse) ProtoMessage()
  • func (x *PublishClientEnvelopesResponse) ProtoReflect() protoreflect.Message
  • func (x *PublishClientEnvelopesResponse) Reset()
  • func (x *PublishClientEnvelopesResponse) String() string
• type UnimplementedPayerApiServer
  • func (UnimplementedPayerApiServer) PublishClientEnvelopes(context.Context, *PublishClientEnvelopesRequest) (*PublishClientEnvelopesResponse, error)
• type UnsafePayerApiServer

Constants

const (
	PayerApi_PublishClientEnvelopes_FullMethodName = "/xmtp.xmtpv4.payer_api.PayerApi/PublishClientEnvelopes"
)

Variables

var File_xmtpv4_payer_api_payer_api_proto protoreflect.FileDescriptor

var PayerApi_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "xmtp.xmtpv4.payer_api.PayerApi",
	HandlerType: (*PayerApiServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "PublishClientEnvelopes",
			Handler:    _PayerApi_PublishClientEnvelopes_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "xmtpv4/payer_api/payer_api.proto",
}

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

Functions

func RegisterPayerApiHandler

func RegisterPayerApiHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterPayerApiHandler registers the http handlers for service PayerApi to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterPayerApiHandlerClient

func RegisterPayerApiHandlerClient(ctx context.Context, mux *runtime.ServeMux, client PayerApiClient) error

RegisterPayerApiHandlerClient registers the http handlers for service PayerApi to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "PayerApiClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "PayerApiClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "PayerApiClient" to call the correct interceptors.

func RegisterPayerApiHandlerFromEndpoint

func RegisterPayerApiHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterPayerApiHandlerFromEndpoint is same as RegisterPayerApiHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterPayerApiHandlerServer

func RegisterPayerApiHandlerServer(ctx context.Context, mux *runtime.ServeMux, server PayerApiServer) error

RegisterPayerApiHandlerServer registers the http handlers for service PayerApi to "mux". UnaryRPC :call PayerApiServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterPayerApiHandlerFromEndpoint instead.

func RegisterPayerApiServer

func RegisterPayerApiServer(s grpc.ServiceRegistrar, srv PayerApiServer)

Types

type PayerApiClient

type PayerApiClient interface {
	// Publish envelope
	PublishClientEnvelopes(ctx context.Context, in *PublishClientEnvelopesRequest, opts ...grpc.CallOption) (*PublishClientEnvelopesResponse, error)
}

PayerApiClient is the client API for PayerApi 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 NewPayerApiClient

func NewPayerApiClient(cc grpc.ClientConnInterface) PayerApiClient

type PayerApiServer

type PayerApiServer interface {
	// Publish envelope
	PublishClientEnvelopes(context.Context, *PublishClientEnvelopesRequest) (*PublishClientEnvelopesResponse, error)
	// contains filtered or unexported methods
}

PayerApiServer is the server API for PayerApi service. All implementations must embed UnimplementedPayerApiServer for forward compatibility

type PublishClientEnvelopesRequest

type PublishClientEnvelopesRequest struct {
	Envelopes []*envelopes.ClientEnvelope `protobuf:"bytes,1,rep,name=envelopes,proto3" json:"envelopes,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishClientEnvelopesRequest) Descriptor

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

Deprecated: Use PublishClientEnvelopesRequest.ProtoReflect.Descriptor instead.

func (*PublishClientEnvelopesRequest) GetEnvelopes

func (x *PublishClientEnvelopesRequest) GetEnvelopes() []*envelopes.ClientEnvelope

func (*PublishClientEnvelopesRequest) ProtoMessage

func (*PublishClientEnvelopesRequest) ProtoMessage()

func (*PublishClientEnvelopesRequest) ProtoReflect

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

func (*PublishClientEnvelopesRequest) Reset

func (x *PublishClientEnvelopesRequest) Reset()

func (*PublishClientEnvelopesRequest) String

func (x *PublishClientEnvelopesRequest) String() string

type PublishClientEnvelopesResponse

type PublishClientEnvelopesResponse struct {
	OriginatorEnvelopes []*envelopes.OriginatorEnvelope `protobuf:"bytes,1,rep,name=originator_envelopes,json=originatorEnvelopes,proto3" json:"originator_envelopes,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishClientEnvelopesResponse) Descriptor

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

Deprecated: Use PublishClientEnvelopesResponse.ProtoReflect.Descriptor instead.

func (*PublishClientEnvelopesResponse) GetOriginatorEnvelopes

func (x *PublishClientEnvelopesResponse) GetOriginatorEnvelopes() []*envelopes.OriginatorEnvelope

func (*PublishClientEnvelopesResponse) ProtoMessage

func (*PublishClientEnvelopesResponse) ProtoMessage()

func (*PublishClientEnvelopesResponse) ProtoReflect

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

func (*PublishClientEnvelopesResponse) Reset

func (x *PublishClientEnvelopesResponse) Reset()

func (*PublishClientEnvelopesResponse) String

func (x *PublishClientEnvelopesResponse) String() string

type UnimplementedPayerApiServer

type UnimplementedPayerApiServer struct {
}

UnimplementedPayerApiServer must be embedded to have forward compatible implementations.

func (UnimplementedPayerApiServer) PublishClientEnvelopes

func (UnimplementedPayerApiServer) PublishClientEnvelopes(context.Context, *PublishClientEnvelopesRequest) (*PublishClientEnvelopesResponse, error)

type UnsafePayerApiServer

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

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