httputils

Documentation

Index

• func GetClientIP(req *http.Request) (string, error)
• func GetOwnIP() (string, error)
• func Is2xx(status int) bool
• func SetReqCtx(targetCtx context.Context, data *RequestContextData) context.Context
• func Write(writer http.ResponseWriter, status int, headers map[string]string, ...)
• type RequestContextData
  • func GetReqCtx(targetCtx context.Context) *RequestContextData

Functions

func GetClientIP

func GetClientIP(req *http.Request) (string, error)

GetClientIP extracts the client IP Address from the given HTTP request.

func GetOwnIP

func GetOwnIP() (string, error)

GetOwnIP gets the IP address of the host machine.

func Is2xx

func Is2xx(status int) bool

Is2xx returns true if the provided status belongs to the 2xx family.

func SetReqCtx

func SetReqCtx(targetCtx context.Context, data *RequestContextData) context.Context

SetReqCtx puts the request's context data into the target context and returns the new context.

func Write

func Write(writer http.ResponseWriter, status int, headers map[string]string, body interface{})

Write writes the provided data as the HTTP response using the provided writer.

Types

type RequestContextData

type RequestContextData struct {
	// ID is the unique identifier of this request.
	ID string
}

RequestContextData is an HTTP request's context information.

func GetReqCtx

func GetReqCtx(targetCtx context.Context) *RequestContextData

GetReqCtx extracts the request's context data from the target context and returns it.