server

Documentation

Index

• Constants
• Variables
• func DefaultToHTTPError(_ error) int
• func InitHTTPDefaultTransport(sConf *config.ServiceConfig)
• func NewServer(sConf *config.ServiceConfig, handler http.Handler) *http.Server
• func ParseTLSConfig(tlsConf *config.TLSConfig) *tls.Config
• func RunServer(ctx context.Context, sConf *config.ServiceConfig, handler http.Handler) error
• type ToHTTPError

Constants

const (
	// HeaderCompleteResponseValue - Response가 정상적으로 처리된 경우에 Header에 사용할 값
	HeaderCompleteResponseValue = "true"
	// HeaderIncompleteResponseValue - Response가 비 정상적으로 처리된 경우에 Header에 사용할 값
	HeaderIncompleteResponseValue = "false"
)

Variables

var (
	// MessageResponseHeaderName - Response 오류인 경우 클라이언트에 표시할 Header 명
	MessageResponseHeaderName = "X-" + core.AppName + "-Messages"
	// CompleteResponseHeaderName - Response 정상 여부를 클라이언트에 표시할 Header 명
	CompleteResponseHeaderName = "X-" + core.AppName + "-Completed"
	// HeadersToSend - Router에 도착한 Request에서 Proxy로 전달할 필수 Header 정보들
	HeadersToSend = []string{"Content-Type"}
	// HeadersToNotSend - Router에 도착한 Request에서 Proxy로 전달하지 않을 Header 정보들
	HeadersToNotSend = []string{"Accept-Encoding"}
	// UserAgentHeaderValue - Proxy로 전달할 User-Agent Header 값
	UserAgentHeaderValue = []string{core.AppUserAgent}

	// ErrInternalError - 처리 중에 발생한 오류
	ErrInternalError = errors.New("internal server error")
	// ErrPrivateKey - TLS 설정에서 사용할 Private Key 미 설정 오류
	ErrPrivateKey = errors.New("private key not defined")
	// ErrPublicKey - TLS 설정에서 사용할 Public Key 미 설정 오류
	ErrPublicKey = errors.New("public key not defined")
)

Functions

func DefaultToHTTPError

func DefaultToHTTPError(_ error) int

DefaultToHTTPError - 발생한 오류들을 전부 InternalServerError로 처리하는 기본 오류 처리기

func InitHTTPDefaultTransport

func InitHTTPDefaultTransport(sConf *config.ServiceConfig)

InitHTTPDefaultTransport - 설정 기준으로 단 한번 설정되는 HTTP 설정 초기화

func NewServer

func NewServer(sConf *config.ServiceConfig, handler http.Handler) *http.Server

NewServer - 지정한 설정과 http handler 기준으로 동작하는 http server 반환

func ParseTLSConfig

func ParseTLSConfig(tlsConf *config.TLSConfig) *tls.Config

ParseTLSConfig - 서비스 설정에 지정된 TLS 설정을 기준으로 tls 모듈에 대한 설정 반환

func RunServer

func RunServer(ctx context.Context, sConf *config.ServiceConfig, handler http.Handler) error

RunServer - 지정된 Context와 설정 및 Handler 기반으로 동작하는 HTT Server 구동

Types

type ToHTTPError

type ToHTTPError func(error) int

ToHTTPError - 처리 중에 발생한 오류를 StatusCode로 처리하는 함수 정의