Documentation
¶
Index ¶
- Constants
- func NewAdminServiceHandler(svc AdminServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type AdminServiceClient
- type AdminServiceHandler
- type UnimplementedAdminServiceHandler
- func (UnimplementedAdminServiceHandler) SetReportingPolicy(context.Context, *connect.Request[v1.SetReportingPolicyRequest]) (*connect.Response[v1.SetReportingPolicyResponse], error)
- func (UnimplementedAdminServiceHandler) SetTenantFeeRate(context.Context, *connect.Request[v1.SetTenantFeeRateRequest]) (*connect.Response[v1.SetTenantFeeRateResponse], error)
Constants ¶
const ( // AdminServiceSetTenantFeeRateProcedure is the fully-qualified name of the AdminService's // SetTenantFeeRate RPC. AdminServiceSetTenantFeeRateProcedure = "/fora.admin.v1.AdminService/SetTenantFeeRate" // AdminServiceSetReportingPolicyProcedure is the fully-qualified name of the AdminService's // SetReportingPolicy RPC. AdminServiceSetReportingPolicyProcedure = "/fora.admin.v1.AdminService/SetReportingPolicy" )
These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.
Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.
const (
// AdminServiceName is the fully-qualified name of the AdminService service.
AdminServiceName = "fora.admin.v1.AdminService"
)
Variables ¶
This section is empty.
Functions ¶
func NewAdminServiceHandler ¶
func NewAdminServiceHandler(svc AdminServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewAdminServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.
By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.
Types ¶
type AdminServiceClient ¶
type AdminServiceClient interface {
// Sets the tenant's fee rate (basis points) and optional operator note.
// Full replace: the previous rate and note are overwritten.
SetTenantFeeRate(context.Context, *connect.Request[v1.SetTenantFeeRateRequest]) (*connect.Response[v1.SetTenantFeeRateResponse], error)
// Replaces the tenant's reporting policy (required report fields, quantity
// tolerance, reporting window). Full replace: omitted optional fields clear
// their value so the receiving Exchange's defaults apply.
SetReportingPolicy(context.Context, *connect.Request[v1.SetReportingPolicyRequest]) (*connect.Response[v1.SetReportingPolicyResponse], error)
}
AdminServiceClient is a client for the fora.admin.v1.AdminService service.
func NewAdminServiceClient ¶
func NewAdminServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AdminServiceClient
NewAdminServiceClient constructs a client for the fora.admin.v1.AdminService service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.
The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).
type AdminServiceHandler ¶
type AdminServiceHandler interface {
// Sets the tenant's fee rate (basis points) and optional operator note.
// Full replace: the previous rate and note are overwritten.
SetTenantFeeRate(context.Context, *connect.Request[v1.SetTenantFeeRateRequest]) (*connect.Response[v1.SetTenantFeeRateResponse], error)
// Replaces the tenant's reporting policy (required report fields, quantity
// tolerance, reporting window). Full replace: omitted optional fields clear
// their value so the receiving Exchange's defaults apply.
SetReportingPolicy(context.Context, *connect.Request[v1.SetReportingPolicyRequest]) (*connect.Response[v1.SetReportingPolicyResponse], error)
}
AdminServiceHandler is an implementation of the fora.admin.v1.AdminService service.
type UnimplementedAdminServiceHandler ¶
type UnimplementedAdminServiceHandler struct{}
UnimplementedAdminServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedAdminServiceHandler) SetReportingPolicy ¶
func (UnimplementedAdminServiceHandler) SetReportingPolicy(context.Context, *connect.Request[v1.SetReportingPolicyRequest]) (*connect.Response[v1.SetReportingPolicyResponse], error)
func (UnimplementedAdminServiceHandler) SetTenantFeeRate ¶
func (UnimplementedAdminServiceHandler) SetTenantFeeRate(context.Context, *connect.Request[v1.SetTenantFeeRateRequest]) (*connect.Response[v1.SetTenantFeeRateResponse], error)
Source Files