http

Documentation

Overview

Package HTTP defines an interface to send a http.Request from a client to a Vanadium server. This code is Go-specific since it is only used internally by Vanadium.

Index

• Variables
• type HttpClientMethods
• type HttpClientStub
  • func HttpClient(name string) HttpClientStub
• type HttpServerMethods
• type HttpServerStub
  • func HttpServer(impl HttpServerMethods) HttpServerStub
• type HttpServerStubMethods
• type Request
  • func (x Request) VDLIsZero() bool
  • func (x *Request) VDLRead(dec vdl.Decoder) error
  • func (x Request) VDLWrite(enc vdl.Encoder) error
• type Url
  • func (x Url) VDLIsZero() bool
  • func (x *Url) VDLRead(dec vdl.Decoder) error
  • func (x Url) VDLWrite(enc vdl.Encoder) error

Variables

var HttpDesc rpc.InterfaceDesc = descHttp

HttpDesc describes the Http interface.

Types

type HttpClientMethods

type HttpClientMethods interface {
	// RawDo returns the server's response to req.
	RawDo(_ *context.T, req Request, _ ...rpc.CallOpt) (data []byte, _ error)
}

HttpClientMethods is the client interface containing Http methods.

type HttpClientStub

type HttpClientStub interface {
	HttpClientMethods
	rpc.UniversalServiceMethods
}

HttpClientStub adds universal methods to HttpClientMethods.

func HttpClient

func HttpClient(name string) HttpClientStub

HttpClient returns a client stub for Http.

type HttpServerMethods

type HttpServerMethods interface {
	// RawDo returns the server's response to req.
	RawDo(_ *context.T, _ rpc.ServerCall, req Request) (data []byte, _ error)
}

HttpServerMethods is the interface a server writer implements for Http.

type HttpServerStub

type HttpServerStub interface {
	HttpServerStubMethods
	// Describe the Http interfaces.
	Describe__() []rpc.InterfaceDesc
}

HttpServerStub adds universal methods to HttpServerStubMethods.

func HttpServer

func HttpServer(impl HttpServerMethods) HttpServerStub

HttpServer returns a server stub for Http. It converts an implementation of HttpServerMethods into an object that may be used by rpc.Server.

type HttpServerStubMethods

type HttpServerStubMethods HttpServerMethods

HttpServerStubMethods is the server interface containing Http methods, as expected by rpc.Server. There is no difference between this interface and HttpServerMethods since there are no streaming methods.

type Request

type Request struct {
	Method           string
	Url              Url
	Proto            string
	ProtoMajor       int16
	ProtoMinor       int16
	Header           map[string][]string
	Body             []byte
	ContentLength    int64
	TransferEncoding []string
	Close            bool
	Host             string
	Form             map[string][]string
	PostForm         map[string][]string
	Trailer          map[string][]string
	RemoteAddr       string
	RequestUri       string
}

Request represents the http.Request struct. The MultipartForm field is skipped since the docs indicate that it is ignored by clients in favor of the Body field.

func (Request) VDLIsZero

func (x Request) VDLIsZero() bool

func (*Request) VDLRead

func (x *Request) VDLRead(dec vdl.Decoder) error

func (Request) VDLWrite

func (x Request) VDLWrite(enc vdl.Encoder) error

type Url

type Url struct {
	Scheme   string
	Opaque   string
	Host     string
	Path     string
	RawPath  string
	RawQuery string
	Fragment string
}

Url represents a url.URL struct. The User field is skipped since it is a struct with only unexported fields.

func (Url) VDLIsZero

func (x Url) VDLIsZero() bool

func (*Url) VDLRead

func (x *Url) VDLRead(dec vdl.Decoder) error

func (Url) VDLWrite

func (x Url) VDLWrite(enc vdl.Encoder) error