imageboard

package
v0.0.80 Latest Latest
Warning

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

 Go to latest Published: Jan 26, 2022 License: GPL-3.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const ImageBoardPathPrefix = "/twirp/imageboard.v1.ImageBoard/"

ImageBoardPathPrefix 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_imageboard_imageboard_proto protoreflect.FileDescriptor
View Source 
var ImageBoard_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "imageboard.v1.ImageBoard",
	HandlerType: (*ImageBoardServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SetStatus",
			Handler:    _ImageBoard_SetStatus_Handler,
		},
		{
			MethodName: "GetStatus",
			Handler:    _ImageBoard_GetStatus_Handler,
		},
		{
			MethodName: "Jump",
			Handler:    _ImageBoard_Jump_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "imageboard/imageboard.proto",
}

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

Functions

func RegisterImageBoardServer 

func RegisterImageBoardServer(s grpc.ServiceRegistrar, srv ImageBoardServer)

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 ImageBoard 

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

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

	Jump(context.Context, *JumpReq) (*google_protobuf.Empty, error)
}

func NewImageBoardJSONClient 

func NewImageBoardJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) ImageBoard

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

func NewImageBoardProtobufClient 

func NewImageBoardProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) ImageBoard

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

type ImageBoardClient 

type ImageBoardClient 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)
	Jump(ctx context.Context, in *JumpReq, opts ...grpc.CallOption) (*empty.Empty, error)
}

ImageBoardClient is the client API for ImageBoard 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 NewImageBoardClient 

func NewImageBoardClient(cc grpc.ClientConnInterface) ImageBoardClient

type ImageBoardServer 

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

ImageBoardServer is the server API for ImageBoard service. All implementations must embed UnimplementedImageBoardServer for forward compatibility

type JumpReq 

type JumpReq struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*JumpReq) Descriptor deprecated 

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

Deprecated: Use JumpReq.ProtoReflect.Descriptor instead.

func (*JumpReq) GetName 

func (x *JumpReq) GetName() string

func (*JumpReq) ProtoMessage 

func (*JumpReq) ProtoMessage()

func (*JumpReq) ProtoReflect 

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

func (*JumpReq) Reset 

func (x *JumpReq) Reset()

func (*JumpReq) String 

func (x *JumpReq) String() string

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 Status 

type Status struct {
	Enabled          bool `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	DiskcacheEnabled bool `protobuf:"varint,2,opt,name=diskcache_enabled,json=diskcacheEnabled,proto3" json:"diskcache_enabled,omitempty"`
	MemcacheEnabled  bool `protobuf:"varint,3,opt,name=memcache_enabled,json=memcacheEnabled,proto3" json:"memcache_enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*Status) Descriptor deprecated 

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

Deprecated: Use Status.ProtoReflect.Descriptor instead.

func (*Status) GetDiskcacheEnabled 

func (x *Status) GetDiskcacheEnabled() bool

func (*Status) GetEnabled 

func (x *Status) GetEnabled() bool

func (*Status) GetMemcacheEnabled 

func (x *Status) GetMemcacheEnabled() 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 NewImageBoardServer 

func NewImageBoardServer(svc ImageBoard, opts ...interface{}) TwirpServer

NewImageBoardServer 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 UnimplementedImageBoardServer 

type UnimplementedImageBoardServer struct {
}

UnimplementedImageBoardServer must be embedded to have forward compatible implementations.

func (UnimplementedImageBoardServer) GetStatus 

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

func (UnimplementedImageBoardServer) Jump 

func (UnimplementedImageBoardServer) Jump(context.Context, *JumpReq) (*empty.Empty, error)

func (UnimplementedImageBoardServer) SetStatus 

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

type UnsafeImageBoardServer 

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

UnsafeImageBoardServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ImageBoardServer 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.