gateway

Documentation

Index

• func NewBodyWriter() *bodyWriter
• type BodyWriter
• type CloseHandler
• type ConnectHandler
• type Gateway
• type HeaderWriter
  • func NewHeaderWriter() *HeaderWriter
  • func (hw HeaderWriter) Release()
  • func (hw HeaderWriter) Set(key, value string)
• type MessageHandler
• type Protocol
  • func (p Protocol) String() string
• type ProxyFactory
• type ProxyHandle
• 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 Gateway

type Gateway interface {
	Start()
	Run()
	Shutdown()
	GetConn(connID uint64) rony.Conn
	Addr() []string
	Protocol() Protocol
}

Gateway defines the gateway interface where clients could connect and communicate with the edge server

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, bypass bool)

type Protocol

type Protocol int32

const (
	Undefined Protocol = 0
	Dummy     Protocol = 1 << iota
	Http
	Websocket
	Quic
	Grpc
	TCP = Http | Websocket // Http & Websocket
)

func (Protocol) String

func (p Protocol) String() string

type ProxyFactory

type ProxyFactory interface {
	Get() ProxyHandle
}

ProxyFactory is the factory which generates ProxyHandle.

type ProxyHandle

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

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

type RequestCtx

type RequestCtx = fasthttp.RequestCtx