upnp

Documentation

Overview

Package upnp 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:

upnp.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type GeneralRequest
  • func (*GeneralRequest) Descriptor() ([]byte, []int)
  • func (m *GeneralRequest) GetPortNumber() uint32
  • func (*GeneralRequest) ProtoMessage()
  • func (m *GeneralRequest) Reset()
  • func (m *GeneralRequest) String() string
  • func (m *GeneralRequest) XXX_DiscardUnknown()
  • func (m *GeneralRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *GeneralRequest) XXX_Merge(src proto.Message)
  • func (m *GeneralRequest) XXX_Size() int
  • func (m *GeneralRequest) XXX_Unmarshal(b []byte) error
• type GeneralResponse
  • func (*GeneralResponse) Descriptor() ([]byte, []int)
  • func (m *GeneralResponse) GetMessage() string
  • func (*GeneralResponse) ProtoMessage()
  • func (m *GeneralResponse) Reset()
  • func (m *GeneralResponse) String() string
  • func (m *GeneralResponse) XXX_DiscardUnknown()
  • func (m *GeneralResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *GeneralResponse) XXX_Merge(src proto.Message)
  • func (m *GeneralResponse) XXX_Size() int
  • func (m *GeneralResponse) XXX_Unmarshal(b []byte) error
• type HTTPClient
• type TwirpServer
  • func NewUpnpServer(svc Upnp, hooks *twirp.ServerHooks) TwirpServer
• type Upnp
  • func NewUpnpJSONClient(addr string, client HTTPClient) Upnp
  • func NewUpnpProtobufClient(addr string, client HTTPClient) Upnp

Constants

const UpnpPathPrefix = "/twirp/upnp.Upnp/"

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

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 GeneralRequest

type GeneralRequest struct {
	PortNumber           uint32   `protobuf:"varint,1,opt,name=portNumber,proto3" json:"portNumber,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

func (*GeneralRequest) Descriptor

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

func (*GeneralRequest) GetPortNumber

func (m *GeneralRequest) GetPortNumber() uint32

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 NewUpnpServer

func NewUpnpServer(svc Upnp, hooks *twirp.ServerHooks) TwirpServer

type Upnp

type Upnp interface {
	GetGateway(context.Context, *GeneralRequest) (*GeneralResponse, error)

	ForwardPortSilent(context.Context, *GeneralRequest) (*GeneralResponse, error)

	ForwardPort(context.Context, *GeneralRequest) (*GeneralResponse, error)

	RemoveForwarding(context.Context, *GeneralRequest) (*GeneralResponse, error)
}

func NewUpnpJSONClient

func NewUpnpJSONClient(addr string, client HTTPClient) Upnp

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

func NewUpnpProtobufClient

func NewUpnpProtobufClient(addr string, client HTTPClient) Upnp

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