sportboard

package
v0.0.69 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 22, 2021 License: GPL-3.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const SportPathPrefix = "/twirp/sport.v1.Sport/"

SportPathPrefix is a convenience constant that may identify URL paths. Should be used with caution, it only matches routes generated by Twirp Go clients, with the default "/twirp" prefix and default CamelCase service and method names. More info: https://twitchtv.github.io/twirp/docs/routing.html

Variables

View Source 
var File_sportboard_sportboard_proto protoreflect.FileDescriptor
View Source 
var Sport_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "sport.v1.Sport",
	HandlerType: (*SportServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetStatus",
			Handler:    _Sport_SetStatus_Handler,
		},
		{
			MethodName: "GetStatus",
			Handler:    _Sport_GetStatus_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "sportboard/sportboard.proto",
}

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

Functions

func RegisterSportServer 

func RegisterSportServer(s grpc.ServiceRegistrar, srv SportServer)

func WriteError 

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)

Types

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.

HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.

type SetStatusReq 

type SetStatusReq struct {
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*SetStatusReq) Descriptor deprecated 

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

Deprecated: Use SetStatusReq.ProtoReflect.Descriptor instead.

func (*SetStatusReq) GetStatus 

func (x *SetStatusReq) GetStatus() *Status

func (*SetStatusReq) ProtoMessage 

func (*SetStatusReq) ProtoMessage()

func (*SetStatusReq) ProtoReflect 

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

func (*SetStatusReq) Reset 

func (x *SetStatusReq) Reset()

func (*SetStatusReq) String 

func (x *SetStatusReq) String() string

type Sport 

type Sport interface {
	SetStatus(context.Context, *SetStatusReq) (*google_protobuf.Empty, error)

	GetStatus(context.Context, *google_protobuf.Empty) (*StatusResp, error)
}

func NewSportJSONClient 

func NewSportJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Sport

NewSportJSONClient creates a JSON client that implements the Sport interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewSportProtobufClient 

func NewSportProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Sport

NewSportProtobufClient creates a Protobuf client that implements the Sport interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type SportClient 

type SportClient interface {
	SetStatus(ctx context.Context, in *SetStatusReq, opts ...grpc.CallOption) (*empty.Empty, error)
	GetStatus(ctx context.Context, in *empty.Empty, opts ...grpc.CallOption) (*StatusResp, error)
}

SportClient is the client API for Sport 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 NewSportClient 

func NewSportClient(cc grpc.ClientConnInterface) SportClient

type SportServer 

type SportServer interface {
	SetStatus(context.Context, *SetStatusReq) (*empty.Empty, error)
	GetStatus(context.Context, *empty.Empty) (*StatusResp, error)
	// contains filtered or unexported methods
}

SportServer is the server API for Sport service. All implementations must embed UnimplementedSportServer for forward compatibility

type Status 

type Status struct {
	Enabled            bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	FavoriteHidden     bool `protobuf:"varint,2,opt,name=favorite_hidden,json=favoriteHidden,proto3" json:"favorite_hidden,omitempty"`
	FavoriteSticky     bool `protobuf:"varint,3,opt,name=favorite_sticky,json=favoriteSticky,proto3" json:"favorite_sticky,omitempty"`
	ScrollEnabled      bool `protobuf:"varint,4,opt,name=scroll_enabled,json=scrollEnabled,proto3" json:"scroll_enabled,omitempty"`
	TightScrollEnabled bool `protobuf:"varint,5,opt,name=tight_scroll_enabled,json=tightScrollEnabled,proto3" json:"tight_scroll_enabled,omitempty"`
	RecordRankEnabled  bool `protobuf:"varint,6,opt,name=record_rank_enabled,json=recordRankEnabled,proto3" json:"record_rank_enabled,omitempty"`
	OddsEnabled        bool `protobuf:"varint,7,opt,name=odds_enabled,json=oddsEnabled,proto3" json:"odds_enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetEnabled 

func (x *Status) GetEnabled() bool

func (*Status) GetFavoriteHidden 

func (x *Status) GetFavoriteHidden() bool

func (*Status) GetFavoriteSticky 

func (x *Status) GetFavoriteSticky() bool

func (*Status) GetOddsEnabled 

func (x *Status) GetOddsEnabled() bool

func (*Status) GetRecordRankEnabled 

func (x *Status) GetRecordRankEnabled() bool

func (*Status) GetScrollEnabled 

func (x *Status) GetScrollEnabled() bool

func (*Status) GetTightScrollEnabled 

func (x *Status) GetTightScrollEnabled() bool

func (*Status) ProtoMessage 

func (*Status) ProtoMessage()

func (*Status) ProtoReflect 

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

func (*Status) Reset 

func (x *Status) Reset()

func (*Status) String 

func (x *Status) String() string

type StatusResp 

type StatusResp struct {
	Status *Status `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusResp) Descriptor deprecated 

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

Deprecated: Use StatusResp.ProtoReflect.Descriptor instead.

func (*StatusResp) GetStatus 

func (x *StatusResp) GetStatus() *Status

func (*StatusResp) ProtoMessage 

func (*StatusResp) ProtoMessage()

func (*StatusResp) ProtoReflect 

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

func (*StatusResp) Reset 

func (x *StatusResp) Reset()

func (*StatusResp) String 

func (x *StatusResp) String() string

type TwirpServer 

type TwirpServer interface {
	http.Handler

	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// google.golang.org/protobuf/types/descriptorpb.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)

	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string

	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route Twirp requests.
	// The path prefix is in the form: "/<prefix>/<package>.<Service>/"
	// that is, everything in a Twirp route except for the <Method> at the end.
	PathPrefix() string
}

TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.

func NewSportServer 

func NewSportServer(svc Sport, opts ...interface{}) TwirpServer

NewSportServer builds a TwirpServer that can be used as an http.Handler to handle HTTP requests that are routed to the right method in the provided svc implementation. The opts are twirp.ServerOption modifiers, for example twirp.WithServerHooks(hooks).

type UnimplementedSportServer 

type UnimplementedSportServer struct {
}

UnimplementedSportServer must be embedded to have forward compatible implementations.

func (UnimplementedSportServer) GetStatus 

func (UnimplementedSportServer) GetStatus(context.Context, *empty.Empty) (*StatusResp, error)

func (UnimplementedSportServer) SetStatus 

func (UnimplementedSportServer) SetStatus(context.Context, *SetStatusReq) (*empty.Empty, error)

type UnsafeSportServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.