Documentation ¶
Index ¶
- Variables
- func NewTwitchCacheServer(options *cache.ClientOptions) *grpc.Server
- func RegisterTwitchCacheServer(s grpc.ServiceRegistrar, srv TwitchCacheServer)
- type Channel
- func (*Channel) Descriptor() ([]byte, []int)deprecated
- func (x *Channel) GetDisplayName() string
- func (x *Channel) GetID() string
- func (x *Channel) GetIsLive() bool
- func (x *Channel) GetThumbnailURL() string
- func (x *Channel) GetTitle() string
- func (*Channel) ProtoMessage()
- func (x *Channel) ProtoReflect() protoreflect.Message
- func (x *Channel) Reset()
- func (x *Channel) String() string
- type ChannelSearchQuery
- func (*ChannelSearchQuery) Descriptor() ([]byte, []int)deprecated
- func (x *ChannelSearchQuery) GetLiveOnly() bool
- func (x *ChannelSearchQuery) GetName() string
- func (*ChannelSearchQuery) ProtoMessage()
- func (x *ChannelSearchQuery) ProtoReflect() protoreflect.Message
- func (x *ChannelSearchQuery) Reset()
- func (x *ChannelSearchQuery) String() string
- type Channels
- type Game
- type Games
- type MultiQuery
- type Status
- func (*Status) Descriptor() ([]byte, []int)deprecated
- func (x *Status) GetAlloc() uint64
- func (x *Status) GetCacheSize() uint32
- func (x *Status) GetNumGC() uint32
- func (x *Status) GetSys() uint64
- func (*Status) ProtoMessage()
- func (x *Status) ProtoReflect() protoreflect.Message
- func (x *Status) Reset()
- func (x *Status) String() string
- type StatusParams
- type Stream
- func (*Stream) Descriptor() ([]byte, []int)deprecated
- func (x *Stream) GetGameID() string
- func (x *Stream) GetID() string
- func (x *Stream) GetTitle() string
- func (x *Stream) GetUserID() string
- func (x *Stream) GetUserName() string
- func (*Stream) ProtoMessage()
- func (x *Stream) ProtoReflect() protoreflect.Message
- func (x *Stream) Reset()
- func (x *Stream) String() string
- type Streams
- type TwitchCacheClient
- type TwitchCacheServer
- type UnimplementedTwitchCacheServer
- func (UnimplementedTwitchCacheServer) GetGames(context.Context, *MultiQuery) (*Games, error)
- func (UnimplementedTwitchCacheServer) GetStatus(context.Context, *StatusParams) (*Status, error)
- func (UnimplementedTwitchCacheServer) GetStreams(context.Context, *MultiQuery) (*Streams, error)
- func (UnimplementedTwitchCacheServer) GetUsers(context.Context, *MultiQuery) (*Users, error)
- func (UnimplementedTwitchCacheServer) GetUsersAndGames(context.Context, *UsersAndGamesParams) (*UsersAndGames, error)
- func (UnimplementedTwitchCacheServer) SearchChannels(context.Context, *ChannelSearchQuery) (*Channels, error)
- type UnsafeTwitchCacheServer
- type User
- func (*User) Descriptor() ([]byte, []int)deprecated
- func (x *User) GetDescription() string
- func (x *User) GetDisplayName() string
- func (x *User) GetID() string
- func (x *User) GetLogin() string
- func (x *User) GetProfileImageURL() string
- func (*User) ProtoMessage()
- func (x *User) ProtoReflect() protoreflect.Message
- func (x *User) Reset()
- func (x *User) String() string
- type Users
- type UsersAndGames
- func (*UsersAndGames) Descriptor() ([]byte, []int)deprecated
- func (x *UsersAndGames) GetGames() *Games
- func (x *UsersAndGames) GetUsers() *Users
- func (*UsersAndGames) ProtoMessage()
- func (x *UsersAndGames) ProtoReflect() protoreflect.Message
- func (x *UsersAndGames) Reset()
- func (x *UsersAndGames) String() string
- type UsersAndGamesParams
- func (*UsersAndGamesParams) Descriptor() ([]byte, []int)deprecated
- func (x *UsersAndGamesParams) GetGameIDs() []string
- func (x *UsersAndGamesParams) GetUserIDs() []string
- func (*UsersAndGamesParams) ProtoMessage()
- func (x *UsersAndGamesParams) ProtoReflect() protoreflect.Message
- func (x *UsersAndGamesParams) Reset()
- func (x *UsersAndGamesParams) String() string
Constants ¶
This section is empty.
Variables ¶
var File_helix_api_proto protoreflect.FileDescriptor
var TwitchCache_ServiceDesc = grpc.ServiceDesc{ ServiceName: "rpc.TwitchCache", HandlerType: (*TwitchCacheServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetUsersAndGames", Handler: _TwitchCache_GetUsersAndGames_Handler, }, { MethodName: "GetUsers", Handler: _TwitchCache_GetUsers_Handler, }, { MethodName: "GetGames", Handler: _TwitchCache_GetGames_Handler, }, { MethodName: "GetStreams", Handler: _TwitchCache_GetStreams_Handler, }, { MethodName: "SearchChannels", Handler: _TwitchCache_SearchChannels_Handler, }, { MethodName: "GetStatus", Handler: _TwitchCache_GetStatus_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "helix_api.proto", }
TwitchCache_ServiceDesc is the grpc.ServiceDesc for TwitchCache service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func NewTwitchCacheServer ¶
func NewTwitchCacheServer(options *cache.ClientOptions) *grpc.Server
func RegisterTwitchCacheServer ¶
func RegisterTwitchCacheServer(s grpc.ServiceRegistrar, srv TwitchCacheServer)
Types ¶
type Channel ¶
type Channel struct { ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` DisplayName string `protobuf:"bytes,2,opt,name=DisplayName,proto3" json:"DisplayName,omitempty"` Title string `protobuf:"bytes,3,opt,name=Title,proto3" json:"Title,omitempty"` ThumbnailURL string `protobuf:"bytes,4,opt,name=ThumbnailURL,proto3" json:"ThumbnailURL,omitempty"` IsLive bool `protobuf:"varint,5,opt,name=IsLive,proto3" json:"IsLive,omitempty"` // contains filtered or unexported fields }
func (*Channel) Descriptor
deprecated
func (*Channel) GetDisplayName ¶
func (*Channel) GetThumbnailURL ¶
func (*Channel) ProtoMessage ¶
func (*Channel) ProtoMessage()
func (*Channel) ProtoReflect ¶
func (x *Channel) ProtoReflect() protoreflect.Message
type ChannelSearchQuery ¶
type ChannelSearchQuery struct { Name string `protobuf:"bytes,1,opt,name=Name,proto3" json:"Name,omitempty"` LiveOnly bool `protobuf:"varint,2,opt,name=LiveOnly,proto3" json:"LiveOnly,omitempty"` // contains filtered or unexported fields }
func (*ChannelSearchQuery) Descriptor
deprecated
func (*ChannelSearchQuery) Descriptor() ([]byte, []int)
Deprecated: Use ChannelSearchQuery.ProtoReflect.Descriptor instead.
func (*ChannelSearchQuery) GetLiveOnly ¶
func (x *ChannelSearchQuery) GetLiveOnly() bool
func (*ChannelSearchQuery) GetName ¶
func (x *ChannelSearchQuery) GetName() string
func (*ChannelSearchQuery) ProtoMessage ¶
func (*ChannelSearchQuery) ProtoMessage()
func (*ChannelSearchQuery) ProtoReflect ¶
func (x *ChannelSearchQuery) ProtoReflect() protoreflect.Message
func (*ChannelSearchQuery) Reset ¶
func (x *ChannelSearchQuery) Reset()
func (*ChannelSearchQuery) String ¶
func (x *ChannelSearchQuery) String() string
type Channels ¶
type Channels struct { Channels []*Channel `protobuf:"bytes,1,rep,name=Channels,proto3" json:"Channels,omitempty"` // contains filtered or unexported fields }
func (*Channels) Descriptor
deprecated
func (*Channels) GetChannels ¶
func (*Channels) ProtoMessage ¶
func (*Channels) ProtoMessage()
func (*Channels) ProtoReflect ¶
func (x *Channels) ProtoReflect() protoreflect.Message
type Game ¶
type Game struct { ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` Name string `protobuf:"bytes,2,opt,name=Name,proto3" json:"Name,omitempty"` BoxArtURL string `protobuf:"bytes,3,opt,name=BoxArtURL,proto3" json:"BoxArtURL,omitempty"` // contains filtered or unexported fields }
func (*Game) Descriptor
deprecated
func (*Game) GetBoxArtURL ¶
func (*Game) ProtoMessage ¶
func (*Game) ProtoMessage()
func (*Game) ProtoReflect ¶
func (x *Game) ProtoReflect() protoreflect.Message
type Games ¶
type Games struct { Games []*Game `protobuf:"bytes,1,rep,name=Games,proto3" json:"Games,omitempty"` // contains filtered or unexported fields }
func (*Games) Descriptor
deprecated
func (*Games) ProtoMessage ¶
func (*Games) ProtoMessage()
func (*Games) ProtoReflect ¶
func (x *Games) ProtoReflect() protoreflect.Message
type MultiQuery ¶
type MultiQuery struct { IDs []string `protobuf:"bytes,1,rep,name=IDs,proto3" json:"IDs,omitempty"` Names []string `protobuf:"bytes,2,rep,name=Names,proto3" json:"Names,omitempty"` // contains filtered or unexported fields }
func (*MultiQuery) Descriptor
deprecated
func (*MultiQuery) Descriptor() ([]byte, []int)
Deprecated: Use MultiQuery.ProtoReflect.Descriptor instead.
func (*MultiQuery) GetIDs ¶
func (x *MultiQuery) GetIDs() []string
func (*MultiQuery) GetNames ¶
func (x *MultiQuery) GetNames() []string
func (*MultiQuery) ProtoMessage ¶
func (*MultiQuery) ProtoMessage()
func (*MultiQuery) ProtoReflect ¶
func (x *MultiQuery) ProtoReflect() protoreflect.Message
func (*MultiQuery) Reset ¶
func (x *MultiQuery) Reset()
func (*MultiQuery) String ¶
func (x *MultiQuery) String() string
type Status ¶
type Status struct { Alloc uint64 `protobuf:"varint,1,opt,name=Alloc,proto3" json:"Alloc,omitempty"` Sys uint64 `protobuf:"varint,2,opt,name=Sys,proto3" json:"Sys,omitempty"` NumGC uint32 `protobuf:"varint,3,opt,name=NumGC,proto3" json:"NumGC,omitempty"` CacheSize uint32 `protobuf:"varint,4,opt,name=CacheSize,proto3" json:"CacheSize,omitempty"` // contains filtered or unexported fields }
func (*Status) Descriptor
deprecated
func (*Status) GetCacheSize ¶
func (*Status) ProtoMessage ¶
func (*Status) ProtoMessage()
func (*Status) ProtoReflect ¶
func (x *Status) ProtoReflect() protoreflect.Message
type StatusParams ¶
type StatusParams struct {
// contains filtered or unexported fields
}
func (*StatusParams) Descriptor
deprecated
func (*StatusParams) Descriptor() ([]byte, []int)
Deprecated: Use StatusParams.ProtoReflect.Descriptor instead.
func (*StatusParams) ProtoMessage ¶
func (*StatusParams) ProtoMessage()
func (*StatusParams) ProtoReflect ¶
func (x *StatusParams) ProtoReflect() protoreflect.Message
func (*StatusParams) Reset ¶
func (x *StatusParams) Reset()
func (*StatusParams) String ¶
func (x *StatusParams) String() string
type Stream ¶
type Stream struct { ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` UserID string `protobuf:"bytes,2,opt,name=UserID,proto3" json:"UserID,omitempty"` UserName string `protobuf:"bytes,3,opt,name=UserName,proto3" json:"UserName,omitempty"` GameID string `protobuf:"bytes,4,opt,name=GameID,proto3" json:"GameID,omitempty"` Title string `protobuf:"bytes,5,opt,name=Title,proto3" json:"Title,omitempty"` // contains filtered or unexported fields }
func (*Stream) Descriptor
deprecated
func (*Stream) GetUserName ¶
func (*Stream) ProtoMessage ¶
func (*Stream) ProtoMessage()
func (*Stream) ProtoReflect ¶
func (x *Stream) ProtoReflect() protoreflect.Message
type Streams ¶
type Streams struct { Streams []*Stream `protobuf:"bytes,1,rep,name=Streams,proto3" json:"Streams,omitempty"` // contains filtered or unexported fields }
func (*Streams) Descriptor
deprecated
func (*Streams) GetStreams ¶
func (*Streams) ProtoMessage ¶
func (*Streams) ProtoMessage()
func (*Streams) ProtoReflect ¶
func (x *Streams) ProtoReflect() protoreflect.Message
type TwitchCacheClient ¶
type TwitchCacheClient interface { GetUsersAndGames(ctx context.Context, in *UsersAndGamesParams, opts ...grpc.CallOption) (*UsersAndGames, error) GetUsers(ctx context.Context, in *MultiQuery, opts ...grpc.CallOption) (*Users, error) GetGames(ctx context.Context, in *MultiQuery, opts ...grpc.CallOption) (*Games, error) GetStreams(ctx context.Context, in *MultiQuery, opts ...grpc.CallOption) (*Streams, error) SearchChannels(ctx context.Context, in *ChannelSearchQuery, opts ...grpc.CallOption) (*Channels, error) GetStatus(ctx context.Context, in *StatusParams, opts ...grpc.CallOption) (*Status, error) }
TwitchCacheClient is the client API for TwitchCache 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 NewTwitchCacheClient ¶
func NewTwitchCacheClient(cc grpc.ClientConnInterface) TwitchCacheClient
type TwitchCacheServer ¶
type TwitchCacheServer interface { GetUsersAndGames(context.Context, *UsersAndGamesParams) (*UsersAndGames, error) GetUsers(context.Context, *MultiQuery) (*Users, error) GetGames(context.Context, *MultiQuery) (*Games, error) GetStreams(context.Context, *MultiQuery) (*Streams, error) SearchChannels(context.Context, *ChannelSearchQuery) (*Channels, error) GetStatus(context.Context, *StatusParams) (*Status, error) // contains filtered or unexported methods }
TwitchCacheServer is the server API for TwitchCache service. All implementations must embed UnimplementedTwitchCacheServer for forward compatibility
type UnimplementedTwitchCacheServer ¶
type UnimplementedTwitchCacheServer struct { }
UnimplementedTwitchCacheServer must be embedded to have forward compatible implementations.
func (UnimplementedTwitchCacheServer) GetGames ¶
func (UnimplementedTwitchCacheServer) GetGames(context.Context, *MultiQuery) (*Games, error)
func (UnimplementedTwitchCacheServer) GetStatus ¶
func (UnimplementedTwitchCacheServer) GetStatus(context.Context, *StatusParams) (*Status, error)
func (UnimplementedTwitchCacheServer) GetStreams ¶
func (UnimplementedTwitchCacheServer) GetStreams(context.Context, *MultiQuery) (*Streams, error)
func (UnimplementedTwitchCacheServer) GetUsers ¶
func (UnimplementedTwitchCacheServer) GetUsers(context.Context, *MultiQuery) (*Users, error)
func (UnimplementedTwitchCacheServer) GetUsersAndGames ¶
func (UnimplementedTwitchCacheServer) GetUsersAndGames(context.Context, *UsersAndGamesParams) (*UsersAndGames, error)
func (UnimplementedTwitchCacheServer) SearchChannels ¶
func (UnimplementedTwitchCacheServer) SearchChannels(context.Context, *ChannelSearchQuery) (*Channels, error)
type UnsafeTwitchCacheServer ¶
type UnsafeTwitchCacheServer interface {
// contains filtered or unexported methods
}
UnsafeTwitchCacheServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to TwitchCacheServer will result in compilation errors.
type User ¶
type User struct { ID string `protobuf:"bytes,1,opt,name=ID,proto3" json:"ID,omitempty"` Login string `protobuf:"bytes,2,opt,name=Login,proto3" json:"Login,omitempty"` DisplayName string `protobuf:"bytes,3,opt,name=DisplayName,proto3" json:"DisplayName,omitempty"` Description string `protobuf:"bytes,4,opt,name=Description,proto3" json:"Description,omitempty"` ProfileImageURL string `protobuf:"bytes,5,opt,name=ProfileImageURL,proto3" json:"ProfileImageURL,omitempty"` // contains filtered or unexported fields }
func (*User) Descriptor
deprecated
func (*User) GetDescription ¶
func (*User) GetDisplayName ¶
func (*User) GetProfileImageURL ¶
func (*User) ProtoMessage ¶
func (*User) ProtoMessage()
func (*User) ProtoReflect ¶
func (x *User) ProtoReflect() protoreflect.Message
type Users ¶
type Users struct { Users []*User `protobuf:"bytes,1,rep,name=Users,proto3" json:"Users,omitempty"` // contains filtered or unexported fields }
func (*Users) Descriptor
deprecated
func (*Users) ProtoMessage ¶
func (*Users) ProtoMessage()
func (*Users) ProtoReflect ¶
func (x *Users) ProtoReflect() protoreflect.Message
type UsersAndGames ¶
type UsersAndGames struct { Users *Users `protobuf:"bytes,1,opt,name=Users,proto3" json:"Users,omitempty"` Games *Games `protobuf:"bytes,2,opt,name=Games,proto3" json:"Games,omitempty"` // contains filtered or unexported fields }
func (*UsersAndGames) Descriptor
deprecated
func (*UsersAndGames) Descriptor() ([]byte, []int)
Deprecated: Use UsersAndGames.ProtoReflect.Descriptor instead.
func (*UsersAndGames) GetGames ¶
func (x *UsersAndGames) GetGames() *Games
func (*UsersAndGames) GetUsers ¶
func (x *UsersAndGames) GetUsers() *Users
func (*UsersAndGames) ProtoMessage ¶
func (*UsersAndGames) ProtoMessage()
func (*UsersAndGames) ProtoReflect ¶
func (x *UsersAndGames) ProtoReflect() protoreflect.Message
func (*UsersAndGames) Reset ¶
func (x *UsersAndGames) Reset()
func (*UsersAndGames) String ¶
func (x *UsersAndGames) String() string
type UsersAndGamesParams ¶
type UsersAndGamesParams struct { UserIDs []string `protobuf:"bytes,1,rep,name=UserIDs,proto3" json:"UserIDs,omitempty"` GameIDs []string `protobuf:"bytes,2,rep,name=GameIDs,proto3" json:"GameIDs,omitempty"` // contains filtered or unexported fields }
func (*UsersAndGamesParams) Descriptor
deprecated
func (*UsersAndGamesParams) Descriptor() ([]byte, []int)
Deprecated: Use UsersAndGamesParams.ProtoReflect.Descriptor instead.
func (*UsersAndGamesParams) GetGameIDs ¶
func (x *UsersAndGamesParams) GetGameIDs() []string
func (*UsersAndGamesParams) GetUserIDs ¶
func (x *UsersAndGamesParams) GetUserIDs() []string
func (*UsersAndGamesParams) ProtoMessage ¶
func (*UsersAndGamesParams) ProtoMessage()
func (*UsersAndGamesParams) ProtoReflect ¶
func (x *UsersAndGamesParams) ProtoReflect() protoreflect.Message
func (*UsersAndGamesParams) Reset ¶
func (x *UsersAndGamesParams) Reset()
func (*UsersAndGamesParams) String ¶
func (x *UsersAndGamesParams) String() string