gateway

Documentation

Index

• func NewBodyWriter() *bodyWriter
• type BodyWriter
• type CloseHandler
• type ConnectHandler
• type HeaderWriter
  • func NewHeaderWriter() *HeaderWriter
  • func (hw HeaderWriter) Release()
  • func (hw HeaderWriter) Set(key, value string)
• type MessageHandler
• type Proxy
• type ProxyFactory
• type RequestCtx

Functions

func NewBodyWriter

func NewBodyWriter() *bodyWriter

Types

type BodyWriter

type BodyWriter interface {
	Write(data []byte)
	WriteProto(p proto.Message) error
}

BodyWriter is implemented by bodyWriter internally. This interface is used by the developer to write desired output to the REST http response. WriteProto is a helper function for marshalling and then writing the proto message to the body of http response.

type CloseHandler

type CloseHandler = func(c rony.Conn)

type ConnectHandler

type ConnectHandler = func(c rony.Conn, kvs ...*rony.KeyValue)

type HeaderWriter

type HeaderWriter map[string]string

HeaderWriter is the object responsible for writing response header.

func NewHeaderWriter

func NewHeaderWriter() *HeaderWriter

func (HeaderWriter) Release

func (hw HeaderWriter) Release()

func (HeaderWriter) Set

func (hw HeaderWriter) Set(key, value string)

type MessageHandler

type MessageHandler = func(c rony.Conn, streamID int64, data []byte)

type Proxy

type Proxy interface {
	OnRequest(conn rony.Conn, ctx *RequestCtx, writer BodyWriter)
	OnResponse(data []byte, bodyWriter BodyWriter, hdrWriter *HeaderWriter)
}

Proxy defines the interface for proxy handlers. This is used in 'rest' package to support writing restfull wrappers for the RPC handlers.

type ProxyFactory

type ProxyFactory interface {
	Get() Proxy
	Release(Proxy)
}

ProxyFactory is the factory which generates ProxyHandle.

type RequestCtx

type RequestCtx = fasthttp.RequestCtx