rkmuxinter

Documentation

Overview

Package rkmuxinter provides common utility functions for middleware of mux framework

Index

• Constants
• Variables
• func GetRemoteAddressSet(req *http.Request) (remoteIp, remotePort string)
• func ShouldLog(req *http.Request) bool
• func WriteJson(w http.ResponseWriter, code int, content interface{})
• type RkResponseWriter
  • func WrapResponseWriter(w http.ResponseWriter) *RkResponseWriter
  • func (w *RkResponseWriter) Flush()
  • func (w *RkResponseWriter) Header() http.Header
  • func (w *RkResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)
  • func (w *RkResponseWriter) Write(bytes []byte) (int, error)
  • func (w *RkResponseWriter) WriteHeader(code int)

Constants

const (
	// RpcEntryNameKey entry name key
	RpcEntryNameKey = "muxEntryName"
	// RpcEntryNameValue entry name
	RpcEntryNameValue = "mux"
	// RpcEntryTypeValue entry type
	RpcEntryTypeValue = "mux"
	// RpcEventKey event key
	RpcEventKey = "muxEvent"
	// RpcLoggerKey logger key
	RpcLoggerKey = "muxLogger"
	// RpcTracerKey tracer key
	RpcTracerKey = "muxTracer"
	// RpcSpanKey span key
	RpcSpanKey = "muxSpan"
	// RpcTracerProviderKey trace provider key
	RpcTracerProviderKey = "muxTracerProvider"
	// RpcPropagatorKey propagator key
	RpcPropagatorKey = "muxPropagator"
	// RpcAuthorizationHeaderKey auth key
	RpcAuthorizationHeaderKey = "authorization"
	// RpcApiKeyHeaderKey api auth key
	RpcApiKeyHeaderKey = "X-API-Key"
	// RpcJwtTokenKey key of jwt token in context
	RpcJwtTokenKey = "muxJwt"
	// RpcCsrfTokenKey key of csrf token injected by csrf middleware
	RpcCsrfTokenKey = "muxCsrfToken"
)

Variables

var (
	// Realm environment variable
	Realm = zap.String("realm", rkcommon.GetEnvValueOrDefault("REALM", "*"))
	// Region environment variable
	Region = zap.String("region", rkcommon.GetEnvValueOrDefault("REGION", "*"))
	// AZ environment variable
	AZ = zap.String("az", rkcommon.GetEnvValueOrDefault("AZ", "*"))
	// Domain environment variable
	Domain = zap.String("domain", rkcommon.GetEnvValueOrDefault("DOMAIN", "*"))
	// LocalIp read local IP from localhost
	LocalIp = zap.String("localIp", rkcommon.GetLocalIP())
	// LocalHostname read hostname from localhost
	LocalHostname = zap.String("localHostname", rkcommon.GetLocalHostname())
)

Functions

func GetRemoteAddressSet

func GetRemoteAddressSet(req *http.Request) (remoteIp, remotePort string)

GetRemoteAddressSet returns remote endpoint information set including IP, Port. We will do as best as we can to determine it. If fails, then just return default ones.

func ShouldLog

func ShouldLog(req *http.Request) bool

ShouldLog determines whether should log the RPC

func WriteJson

func WriteJson(w http.ResponseWriter, code int, content interface{})

WriteJson with code and content. Internal error will be written if error occur.

Types

type RkResponseWriter

type RkResponseWriter struct {
	Writer http.ResponseWriter
	Code   int
	Size   atomic.Int
}

A RkResponseWriter is a helper to delay sealing a http.ResponseWriter on writing code.

func WrapResponseWriter

func WrapResponseWriter(w http.ResponseWriter) *RkResponseWriter

WrapResponseWriter if current writer is not RkResponseWriter

func (*RkResponseWriter) Flush

func (w *RkResponseWriter) Flush()

Flush flushes the response writer.

func (*RkResponseWriter) Header

func (w *RkResponseWriter) Header() http.Header

Header returns the http header.

func (*RkResponseWriter) Hijack

func (w *RkResponseWriter) Hijack() (net.Conn, *bufio.ReadWriter, error)

Hijack implements the http.Hijacker interface. This expands the Response to fulfill http.Hijacker if the underlying http.ResponseWriter supports it.

func (*RkResponseWriter) Write

func (w *RkResponseWriter) Write(bytes []byte) (int, error)

Write writes bytes into w.

func (*RkResponseWriter) WriteHeader

func (w *RkResponseWriter) WriteHeader(code int)

WriteHeader writes code into w, and not sealing the writer.