Documentation ¶
Overview ¶
Package service is a generated protocol buffer package.
It is generated from these files:
nyt-proxy.proto
It has these top-level messages:
MostPopularRequest MostPopularResponse CatsRequest CatsResponse
Index ¶
- Variables
- func RegisterNYTProxyServiceServer(s *grpc.Server, srv NYTProxyServiceServer)
- type CatsRequest
- type CatsResponse
- type Config
- type MostPopularRequest
- type MostPopularResponse
- type NYTProxyServiceClient
- type NYTProxyServiceServer
- type RPCService
- func (s *RPCService) GetCats(ctx context.Context, r *CatsRequest) (*CatsResponse, error)
- func (s *RPCService) GetCatsJSON(r *http.Request) (int, interface{}, error)
- func (s *RPCService) GetMostPopular(ctx context.Context, r *MostPopularRequest) (*MostPopularResponse, error)
- func (s *RPCService) GetMostPopularJSON(r *http.Request) (int, interface{}, error)
- func (s *RPCService) JSONEndpoints() map[string]map[string]server.JSONEndpoint
- func (s *RPCService) JSONMiddleware(j server.JSONEndpoint) server.JSONEndpoint
- func (s *RPCService) Middleware(h http.Handler) http.Handler
- func (s *RPCService) Prefix() string
- func (s *RPCService) Service() (*grpc.ServiceDesc, interface{})
Constants ¶
This section is empty.
Variables ¶
var NYTProxyService_serviceDesc = grpc.ServiceDesc{ ServiceName: "service.NYTProxyService", HandlerType: (*NYTProxyServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetMostPopular", Handler: _NYTProxyService_GetMostPopular_Handler, }, { MethodName: "GetCats", Handler: _NYTProxyService_GetCats_Handler, }, }, Streams: []grpc.StreamDesc{}, }
Functions ¶
func RegisterNYTProxyServiceServer ¶
func RegisterNYTProxyServiceServer(s *grpc.Server, srv NYTProxyServiceServer)
Types ¶
type CatsRequest ¶
type CatsRequest struct { }
func (*CatsRequest) Descriptor ¶
func (*CatsRequest) Descriptor() ([]byte, []int)
func (*CatsRequest) ProtoMessage ¶
func (*CatsRequest) ProtoMessage()
func (*CatsRequest) Reset ¶
func (m *CatsRequest) Reset()
func (*CatsRequest) String ¶
func (m *CatsRequest) String() string
type CatsResponse ¶
type CatsResponse struct {
Results []*nyt.SemanticConceptArticle `protobuf:"bytes,1,rep,name=results" json:"results,omitempty"`
}
func (*CatsResponse) Descriptor ¶
func (*CatsResponse) Descriptor() ([]byte, []int)
func (*CatsResponse) GetResults ¶
func (m *CatsResponse) GetResults() []*nyt.SemanticConceptArticle
func (*CatsResponse) ProtoMessage ¶
func (*CatsResponse) ProtoMessage()
func (*CatsResponse) Reset ¶
func (m *CatsResponse) Reset()
func (*CatsResponse) String ¶
func (m *CatsResponse) String() string
type MostPopularRequest ¶
type MostPopularRequest struct { ResourceType string `protobuf:"bytes,1,opt,name=resourceType" json:"resourceType,omitempty"` Section string `protobuf:"bytes,2,opt,name=section" json:"section,omitempty"` TimePeriodDays uint32 `protobuf:"varint,3,opt,name=timePeriodDays" json:"timePeriodDays,omitempty"` }
func (*MostPopularRequest) Descriptor ¶
func (*MostPopularRequest) Descriptor() ([]byte, []int)
func (*MostPopularRequest) ProtoMessage ¶
func (*MostPopularRequest) ProtoMessage()
func (*MostPopularRequest) Reset ¶
func (m *MostPopularRequest) Reset()
func (*MostPopularRequest) String ¶
func (m *MostPopularRequest) String() string
type MostPopularResponse ¶
type MostPopularResponse struct {
Result []*nyt.MostPopularResult `protobuf:"bytes,1,rep,name=result" json:"result,omitempty"`
}
func (*MostPopularResponse) Descriptor ¶
func (*MostPopularResponse) Descriptor() ([]byte, []int)
func (*MostPopularResponse) GetResult ¶
func (m *MostPopularResponse) GetResult() []*nyt.MostPopularResult
func (*MostPopularResponse) ProtoMessage ¶
func (*MostPopularResponse) ProtoMessage()
func (*MostPopularResponse) Reset ¶
func (m *MostPopularResponse) Reset()
func (*MostPopularResponse) String ¶
func (m *MostPopularResponse) String() string
type NYTProxyServiceClient ¶
type NYTProxyServiceClient interface { GetMostPopular(ctx context.Context, in *MostPopularRequest, opts ...grpc.CallOption) (*MostPopularResponse, error) GetCats(ctx context.Context, in *CatsRequest, opts ...grpc.CallOption) (*CatsResponse, error) }
func NewNYTProxyServiceClient ¶
func NewNYTProxyServiceClient(cc *grpc.ClientConn) NYTProxyServiceClient
type NYTProxyServiceServer ¶
type NYTProxyServiceServer interface { GetMostPopular(context.Context, *MostPopularRequest) (*MostPopularResponse, error) GetCats(context.Context, *CatsRequest) (*CatsResponse, error) }
type RPCService ¶
type RPCService struct {
// contains filtered or unexported fields
}
RPCService will implement server.RPCService and handle all requests to the server.
func NewRPCService ¶
func NewRPCService(cfg *Config) *RPCService
NewRPCService will instantiate a RPCService with the given configuration.
func (*RPCService) GetCats ¶
func (s *RPCService) GetCats(ctx context.Context, r *CatsRequest) (*CatsResponse, error)
func (*RPCService) GetCatsJSON ¶
func (s *RPCService) GetCatsJSON(r *http.Request) (int, interface{}, error)
func (*RPCService) GetMostPopular ¶
func (s *RPCService) GetMostPopular(ctx context.Context, r *MostPopularRequest) (*MostPopularResponse, error)
func (*RPCService) GetMostPopularJSON ¶
func (s *RPCService) GetMostPopularJSON(r *http.Request) (int, interface{}, error)
func (*RPCService) JSONEndpoints ¶
func (s *RPCService) JSONEndpoints() map[string]map[string]server.JSONEndpoint
JSONEndpoints is a listing of all endpoints available in the RPCService.
func (*RPCService) JSONMiddleware ¶
func (s *RPCService) JSONMiddleware(j server.JSONEndpoint) server.JSONEndpoint
JSONMiddleware provides a JSONEndpoint hook wrapped around all requests. In this implementation, we're using it to provide application logging and to check errors and provide generic responses.
func (*RPCService) Middleware ¶
func (s *RPCService) Middleware(h http.Handler) http.Handler
Middleware provides an http.Handler hook wrapped around all requests. In this implementation, we're using a GzipHandler middleware to compress our responses.
func (*RPCService) Prefix ¶
func (s *RPCService) Prefix() string
Prefix returns the string prefix used for all endpoints within this service.
func (*RPCService) Service ¶
func (s *RPCService) Service() (*grpc.ServiceDesc, interface{})
Service provides the RPCService with a description of the service to serve and the implementation.