steadyrpc

package
v0.0.0-...-b88123c Latest Latest
Warning

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

 Go to latest Published: May 1, 2023 License: Unlicense Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source 
const SteadyPathPrefix = "/twirp/steady.steady.Steady/"

SteadyPathPrefix 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_steady_proto protoreflect.FileDescriptor

Functions

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 Application 

type Application struct {
	Id     int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	UserId int64  `protobuf:"varint,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	Name   string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Source string `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

func (*Application) Descriptor deprecated 

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

Deprecated: Use Application.ProtoReflect.Descriptor instead.

func (*Application) GetId 

func (x *Application) GetId() int64

func (*Application) GetName 

func (x *Application) GetName() string

func (*Application) GetSource 

func (x *Application) GetSource() string

func (*Application) GetUserId 

func (x *Application) GetUserId() int64

func (*Application) ProtoMessage 

func (*Application) ProtoMessage()

func (*Application) ProtoReflect 

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

func (*Application) Reset 

func (x *Application) Reset()

func (*Application) String 

func (x *Application) String() string

type GetApplicationRequest 

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

func (*GetApplicationRequest) Descriptor deprecated 

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

Deprecated: Use GetApplicationRequest.ProtoReflect.Descriptor instead.

func (*GetApplicationRequest) GetName 

func (x *GetApplicationRequest) GetName() string

func (*GetApplicationRequest) ProtoMessage 

func (*GetApplicationRequest) ProtoMessage()

func (*GetApplicationRequest) ProtoReflect 

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

func (*GetApplicationRequest) Reset 

func (x *GetApplicationRequest) Reset()

func (*GetApplicationRequest) String 

func (x *GetApplicationRequest) String() string

type GetApplicationResponse 

type GetApplicationResponse struct {
	Application *Application `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	Url         string       `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*GetApplicationResponse) Descriptor deprecated 

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

Deprecated: Use GetApplicationResponse.ProtoReflect.Descriptor instead.

func (*GetApplicationResponse) GetApplication 

func (x *GetApplicationResponse) GetApplication() *Application

func (*GetApplicationResponse) GetUrl 

func (x *GetApplicationResponse) GetUrl() string

func (*GetApplicationResponse) ProtoMessage 

func (*GetApplicationResponse) ProtoMessage()

func (*GetApplicationResponse) ProtoReflect 

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

func (*GetApplicationResponse) Reset 

func (x *GetApplicationResponse) Reset()

func (*GetApplicationResponse) String 

func (x *GetApplicationResponse) String() string

type GetUserRequest 

type GetUserRequest struct {
	// contains filtered or unexported fields
}

func (*GetUserRequest) Descriptor deprecated 

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) ProtoMessage 

func (*GetUserRequest) ProtoMessage()

func (*GetUserRequest) ProtoReflect 

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

func (*GetUserRequest) Reset 

func (x *GetUserRequest) Reset()

func (*GetUserRequest) String 

func (x *GetUserRequest) String() string

type GetUserResponse 

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

func (*GetUserResponse) Descriptor deprecated 

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

Deprecated: Use GetUserResponse.ProtoReflect.Descriptor instead.

func (*GetUserResponse) GetUser 

func (x *GetUserResponse) GetUser() *User

func (*GetUserResponse) ProtoMessage 

func (*GetUserResponse) ProtoMessage()

func (*GetUserResponse) ProtoReflect 

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

func (*GetUserResponse) Reset 

func (x *GetUserResponse) Reset()

func (*GetUserResponse) String 

func (x *GetUserResponse) String() string

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 LoginRequest 

type LoginRequest struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Email    string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// contains filtered or unexported fields
}

func (*LoginRequest) Descriptor deprecated 

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

Deprecated: Use LoginRequest.ProtoReflect.Descriptor instead.

func (*LoginRequest) GetEmail 

func (x *LoginRequest) GetEmail() string

func (*LoginRequest) GetUsername 

func (x *LoginRequest) GetUsername() string

func (*LoginRequest) ProtoMessage 

func (*LoginRequest) ProtoMessage()

func (*LoginRequest) ProtoReflect 

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

func (*LoginRequest) Reset 

func (x *LoginRequest) Reset()

func (*LoginRequest) String 

func (x *LoginRequest) String() string

type LoginResponse 

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

func (*LoginResponse) Descriptor deprecated 

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

Deprecated: Use LoginResponse.ProtoReflect.Descriptor instead.

func (*LoginResponse) GetUser 

func (x *LoginResponse) GetUser() *User

func (*LoginResponse) ProtoMessage 

func (*LoginResponse) ProtoMessage()

func (*LoginResponse) ProtoReflect 

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

func (*LoginResponse) Reset 

func (x *LoginResponse) Reset()

func (*LoginResponse) String 

func (x *LoginResponse) String() string

type LogoutRequest 

type LogoutRequest struct {
	// contains filtered or unexported fields
}

func (*LogoutRequest) Descriptor deprecated 

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

Deprecated: Use LogoutRequest.ProtoReflect.Descriptor instead.

func (*LogoutRequest) ProtoMessage 

func (*LogoutRequest) ProtoMessage()

func (*LogoutRequest) ProtoReflect 

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

func (*LogoutRequest) Reset 

func (x *LogoutRequest) Reset()

func (*LogoutRequest) String 

func (x *LogoutRequest) String() string

type LogoutResponse 

type LogoutResponse struct {
	// contains filtered or unexported fields
}

func (*LogoutResponse) Descriptor deprecated 

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

Deprecated: Use LogoutResponse.ProtoReflect.Descriptor instead.

func (*LogoutResponse) ProtoMessage 

func (*LogoutResponse) ProtoMessage()

func (*LogoutResponse) ProtoReflect 

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

func (*LogoutResponse) Reset 

func (x *LogoutResponse) Reset()

func (*LogoutResponse) String 

func (x *LogoutResponse) String() string

type RunApplicationRequest 

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

func (*RunApplicationRequest) Descriptor deprecated 

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

Deprecated: Use RunApplicationRequest.ProtoReflect.Descriptor instead.

func (*RunApplicationRequest) GetName 

func (x *RunApplicationRequest) GetName() string

func (*RunApplicationRequest) GetSource 

func (x *RunApplicationRequest) GetSource() string

func (*RunApplicationRequest) ProtoMessage 

func (*RunApplicationRequest) ProtoMessage()

func (*RunApplicationRequest) ProtoReflect 

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

func (*RunApplicationRequest) Reset 

func (x *RunApplicationRequest) Reset()

func (*RunApplicationRequest) String 

func (x *RunApplicationRequest) String() string

type RunApplicationResponse 

type RunApplicationResponse struct {
	Application *Application `protobuf:"bytes,1,opt,name=application,proto3" json:"application,omitempty"`
	Url         string       `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*RunApplicationResponse) Descriptor deprecated 

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

Deprecated: Use RunApplicationResponse.ProtoReflect.Descriptor instead.

func (*RunApplicationResponse) GetApplication 

func (x *RunApplicationResponse) GetApplication() *Application

func (*RunApplicationResponse) GetUrl 

func (x *RunApplicationResponse) GetUrl() string

func (*RunApplicationResponse) ProtoMessage 

func (*RunApplicationResponse) ProtoMessage()

func (*RunApplicationResponse) ProtoReflect 

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

func (*RunApplicationResponse) Reset 

func (x *RunApplicationResponse) Reset()

func (*RunApplicationResponse) String 

func (x *RunApplicationResponse) String() string

type SignupRequest 

type SignupRequest struct {
	Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
	Email    string `protobuf:"bytes,2,opt,name=email,proto3" json:"email,omitempty"`
	// contains filtered or unexported fields
}

func (*SignupRequest) Descriptor deprecated 

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

Deprecated: Use SignupRequest.ProtoReflect.Descriptor instead.

func (*SignupRequest) GetEmail 

func (x *SignupRequest) GetEmail() string

func (*SignupRequest) GetUsername 

func (x *SignupRequest) GetUsername() string

func (*SignupRequest) ProtoMessage 

func (*SignupRequest) ProtoMessage()

func (*SignupRequest) ProtoReflect 

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

func (*SignupRequest) Reset 

func (x *SignupRequest) Reset()

func (*SignupRequest) String 

func (x *SignupRequest) String() string

type SignupResponse 

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

func (*SignupResponse) Descriptor deprecated 

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

Deprecated: Use SignupResponse.ProtoReflect.Descriptor instead.

func (*SignupResponse) GetUser 

func (x *SignupResponse) GetUser() *User

func (*SignupResponse) ProtoMessage 

func (*SignupResponse) ProtoMessage()

func (*SignupResponse) ProtoReflect 

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

func (*SignupResponse) Reset 

func (x *SignupResponse) Reset()

func (*SignupResponse) String 

func (x *SignupResponse) String() string

type Steady 

type Steady interface {
	Login(context.Context, *LoginRequest) (*LoginResponse, error)

	Signup(context.Context, *SignupRequest) (*SignupResponse, error)

	Logout(context.Context, *LogoutRequest) (*LogoutResponse, error)

	GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)

	ValidateToken(context.Context, *ValidateTokenRequest) (*ValidateTokenResponse, error)

	RunApplication(context.Context, *RunApplicationRequest) (*RunApplicationResponse, error)

	GetApplication(context.Context, *GetApplicationRequest) (*GetApplicationResponse, error)

	UpdateApplication(context.Context, *UpdateApplicationRequest) (*UpdateApplicationResponse, error)
}

func NewSteadyJSONClient 

func NewSteadyJSONClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Steady

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

func NewSteadyProtobufClient 

func NewSteadyProtobufClient(baseURL string, client HTTPClient, opts ...twirp.ClientOption) Steady

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

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 NewSteadyServer 

func NewSteadyServer(svc Steady, opts ...interface{}) TwirpServer

NewSteadyServer 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 UpdateApplicationRequest 

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

func (*UpdateApplicationRequest) Descriptor deprecated 

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

Deprecated: Use UpdateApplicationRequest.ProtoReflect.Descriptor instead.

func (*UpdateApplicationRequest) GetName 

func (x *UpdateApplicationRequest) GetName() string

func (*UpdateApplicationRequest) GetSource 

func (x *UpdateApplicationRequest) GetSource() string

func (*UpdateApplicationRequest) ProtoMessage 

func (*UpdateApplicationRequest) ProtoMessage()

func (*UpdateApplicationRequest) ProtoReflect 

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

func (*UpdateApplicationRequest) Reset 

func (x *UpdateApplicationRequest) Reset()

func (*UpdateApplicationRequest) String 

func (x *UpdateApplicationRequest) String() string

type UpdateApplicationResponse 

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

func (*UpdateApplicationResponse) Descriptor deprecated 

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

Deprecated: Use UpdateApplicationResponse.ProtoReflect.Descriptor instead.

func (*UpdateApplicationResponse) GetApplication 

func (x *UpdateApplicationResponse) GetApplication() *Application

func (*UpdateApplicationResponse) ProtoMessage 

func (*UpdateApplicationResponse) ProtoMessage()

func (*UpdateApplicationResponse) ProtoReflect 

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

func (*UpdateApplicationResponse) Reset 

func (x *UpdateApplicationResponse) Reset()

func (*UpdateApplicationResponse) String 

func (x *UpdateApplicationResponse) String() string

type User 

type User struct {
	Id       int64  `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
	Email    string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	// contains filtered or unexported fields
}

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetEmail 

func (x *User) GetEmail() string

func (*User) GetId 

func (x *User) GetId() int64

func (*User) GetUsername 

func (x *User) GetUsername() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect 

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

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

type ValidateTokenRequest 

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

func (*ValidateTokenRequest) Descriptor deprecated 

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

Deprecated: Use ValidateTokenRequest.ProtoReflect.Descriptor instead.

func (*ValidateTokenRequest) GetToken 

func (x *ValidateTokenRequest) GetToken() string

func (*ValidateTokenRequest) ProtoMessage 

func (*ValidateTokenRequest) ProtoMessage()

func (*ValidateTokenRequest) ProtoReflect 

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

func (*ValidateTokenRequest) Reset 

func (x *ValidateTokenRequest) Reset()

func (*ValidateTokenRequest) String 

func (x *ValidateTokenRequest) String() string

type ValidateTokenResponse 

type ValidateTokenResponse struct {
	User             *User  `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	UserSessionToken string `protobuf:"bytes,2,opt,name=user_session_token,json=userSessionToken,proto3" json:"user_session_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ValidateTokenResponse) Descriptor deprecated 

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

Deprecated: Use ValidateTokenResponse.ProtoReflect.Descriptor instead.

func (*ValidateTokenResponse) GetUser 

func (x *ValidateTokenResponse) GetUser() *User

func (*ValidateTokenResponse) GetUserSessionToken 

func (x *ValidateTokenResponse) GetUserSessionToken() string

func (*ValidateTokenResponse) ProtoMessage 

func (*ValidateTokenResponse) ProtoMessage()

func (*ValidateTokenResponse) ProtoReflect 

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

func (*ValidateTokenResponse) Reset 

func (x *ValidateTokenResponse) Reset()

func (*ValidateTokenResponse) String 

func (x *ValidateTokenResponse) String() string

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.