environment

package
v0.0.0-...-c729bb3 Latest Latest
Warning

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

Go to latest
Published: Mar 10, 2019 License: LGPL-3.0 Imports: 15 Imported by: 0

Documentation

Overview

Package environment is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v5.4.2.

It is generated from these files:

environment.proto

Index

Constants

View Source
const EnvironmentPathPrefix = "/twirp/environment.Environment/"

EnvironmentPathPrefix is used for all URL paths on a twirp Environment server. Requests are always: POST EnvironmentPathPrefix/method It can be used in an HTTP mux to route twirp requests along with non-twirp requests on other routes.

Variables

This section is empty.

Functions

func WriteError

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)

Types

type Environment

func NewEnvironmentJSONClient

func NewEnvironmentJSONClient(addr string, client HTTPClient) Environment

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

func NewEnvironmentProtobufClient

func NewEnvironmentProtobufClient(addr string, client HTTPClient) Environment

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

type GeneralRequest

type GeneralRequest struct {
	VariableType         string   `protobuf:"bytes,1,opt,name=variableType,proto3" json:"variableType,omitempty"`
	Value                string   `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	VariableName         string   `protobuf:"bytes,3,opt,name=variableName,proto3" json:"variableName,omitempty"`
	ReplaceExisting      bool     `protobuf:"varint,4,opt,name=replaceExisting,proto3" json:"replaceExisting,omitempty"`
	Path                 string   `protobuf:"bytes,5,opt,name=path,proto3" json:"path,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GeneralRequest) Descriptor

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

func (*GeneralRequest) GetPath

func (m *GeneralRequest) GetPath() string

func (*GeneralRequest) GetReplaceExisting

func (m *GeneralRequest) GetReplaceExisting() bool

func (*GeneralRequest) GetValue

func (m *GeneralRequest) GetValue() string

func (*GeneralRequest) GetVariableName

func (m *GeneralRequest) GetVariableName() string

func (*GeneralRequest) GetVariableType

func (m *GeneralRequest) GetVariableType() string

func (*GeneralRequest) ProtoMessage

func (*GeneralRequest) ProtoMessage()

func (*GeneralRequest) Reset

func (m *GeneralRequest) Reset()

func (*GeneralRequest) String

func (m *GeneralRequest) String() string

func (*GeneralRequest) XXX_DiscardUnknown

func (m *GeneralRequest) XXX_DiscardUnknown()

func (*GeneralRequest) XXX_Marshal

func (m *GeneralRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GeneralRequest) XXX_Merge

func (m *GeneralRequest) XXX_Merge(src proto.Message)

func (*GeneralRequest) XXX_Size

func (m *GeneralRequest) XXX_Size() int

func (*GeneralRequest) XXX_Unmarshal

func (m *GeneralRequest) XXX_Unmarshal(b []byte) error

type GeneralResponse

type GeneralResponse struct {
	Message              string   `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GeneralResponse) Descriptor

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

func (*GeneralResponse) GetMessage

func (m *GeneralResponse) GetMessage() string

func (*GeneralResponse) ProtoMessage

func (*GeneralResponse) ProtoMessage()

func (*GeneralResponse) Reset

func (m *GeneralResponse) Reset()

func (*GeneralResponse) String

func (m *GeneralResponse) String() string

func (*GeneralResponse) XXX_DiscardUnknown

func (m *GeneralResponse) XXX_DiscardUnknown()

func (*GeneralResponse) XXX_Marshal

func (m *GeneralResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GeneralResponse) XXX_Merge

func (m *GeneralResponse) XXX_Merge(src proto.Message)

func (*GeneralResponse) XXX_Size

func (m *GeneralResponse) XXX_Size() int

func (*GeneralResponse) XXX_Unmarshal

func (m *GeneralResponse) XXX_Unmarshal(b []byte) error

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 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
	// github.com/golang/protobuf/protoc-gen-go/descriptor.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
}

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 NewEnvironmentServer

func NewEnvironmentServer(svc Environment, hooks *twirp.ServerHooks) TwirpServer

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL