Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var File_nitric_proto_http_v1_http_proto protoreflect.FileDescriptor
var Http_ServiceDesc = grpc.ServiceDesc{ ServiceName: "nitric.proto.http.v1.Http", HandlerType: (*HttpServer)(nil), Methods: []grpc.MethodDesc{}, Streams: []grpc.StreamDesc{ { StreamName: "Proxy", Handler: _Http_Proxy_Handler, ServerStreams: true, ClientStreams: true, }, }, Metadata: "nitric/proto/http/v1/http.proto", }
Http_ServiceDesc is the grpc.ServiceDesc for Http service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterHttpServer ¶
func RegisterHttpServer(s grpc.ServiceRegistrar, srv HttpServer)
Types ¶
type ClientMessage ¶
type ClientMessage struct {
// Details of the HTTP server to proxy
Request *HttpProxyRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
// contains filtered or unexported fields
}
func (*ClientMessage) Descriptor
deprecated
func (*ClientMessage) Descriptor() ([]byte, []int)
Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.
func (*ClientMessage) GetRequest ¶
func (x *ClientMessage) GetRequest() *HttpProxyRequest
func (*ClientMessage) ProtoMessage ¶
func (*ClientMessage) ProtoMessage()
func (*ClientMessage) ProtoReflect ¶
func (x *ClientMessage) ProtoReflect() protoreflect.Message
func (*ClientMessage) Reset ¶
func (x *ClientMessage) Reset()
func (*ClientMessage) String ¶
func (x *ClientMessage) String() string
type HttpClient ¶
type HttpClient interface {
// Proxy an HTTP server
Proxy(ctx context.Context, opts ...grpc.CallOption) (Http_ProxyClient, error)
}
HttpClient is the client API for Http 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 NewHttpClient ¶
func NewHttpClient(cc grpc.ClientConnInterface) HttpClient
type HttpProxyRequest ¶
type HttpProxyRequest struct {
// The address the server can be accessed on
Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
// contains filtered or unexported fields
}
func (*HttpProxyRequest) Descriptor
deprecated
func (*HttpProxyRequest) Descriptor() ([]byte, []int)
Deprecated: Use HttpProxyRequest.ProtoReflect.Descriptor instead.
func (*HttpProxyRequest) GetHost ¶
func (x *HttpProxyRequest) GetHost() string
func (*HttpProxyRequest) ProtoMessage ¶
func (*HttpProxyRequest) ProtoMessage()
func (*HttpProxyRequest) ProtoReflect ¶
func (x *HttpProxyRequest) ProtoReflect() protoreflect.Message
func (*HttpProxyRequest) Reset ¶
func (x *HttpProxyRequest) Reset()
func (*HttpProxyRequest) String ¶
func (x *HttpProxyRequest) String() string
type HttpServer ¶
type HttpServer interface {
// Proxy an HTTP server
Proxy(Http_ProxyServer) error
}
HttpServer is the server API for Http service. All implementations should embed UnimplementedHttpServer for forward compatibility
type Http_ProxyClient ¶
type Http_ProxyClient interface {
Send(*ClientMessage) error
Recv() (*ServerMessage, error)
grpc.ClientStream
}
type Http_ProxyServer ¶
type Http_ProxyServer interface {
Send(*ServerMessage) error
Recv() (*ClientMessage, error)
grpc.ServerStream
}
type ServerMessage ¶
type ServerMessage struct {
// contains filtered or unexported fields
}
func (*ServerMessage) Descriptor
deprecated
func (*ServerMessage) Descriptor() ([]byte, []int)
Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.
func (*ServerMessage) ProtoMessage ¶
func (*ServerMessage) ProtoMessage()
func (*ServerMessage) ProtoReflect ¶
func (x *ServerMessage) ProtoReflect() protoreflect.Message
func (*ServerMessage) Reset ¶
func (x *ServerMessage) Reset()
func (*ServerMessage) String ¶
func (x *ServerMessage) String() string
type UnimplementedHttpServer ¶
type UnimplementedHttpServer struct {
}
UnimplementedHttpServer should be embedded to have forward compatible implementations.
func (UnimplementedHttpServer) Proxy ¶
func (UnimplementedHttpServer) Proxy(Http_ProxyServer) error
type UnsafeHttpServer ¶
type UnsafeHttpServer interface {
// contains filtered or unexported methods
}
UnsafeHttpServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to HttpServer will result in compilation errors.
Source Files