config

Documentation

Index

• type Config
  • func (T *Config) ParseFile(file string) error
  • func (T *Config) ParseReader(r io.Reader) error
• type Conn
• type Listen
• type Server
• type ServerPublic
  • func (T *ServerPublic) ConfigConn(origin *Conn, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *ServerPublic) ConfigServer(origin *Server, handle func(name string, dsc, src reflect.Value) bool) bool
• type ServerTLS
  • func (T *ServerTLS) CipherSuitesAuto()
• type ServerTLSFile
• type Servers
• type Site
• type SiteDirectory
  • func (T *SiteDirectory) RootDir(upath string) string
• type SiteDynamic
• type SiteForward
  • func (T *SiteForward) Rewrite(upath string) (rpath string, rewrited bool, err error)
• type SiteForwards
• type SiteHeader
• type SiteHeaderType
• type SiteLog
• type SiteLogLevel
• type SitePlugin
  • func (T *SitePlugin) ConfigPluginHTTPClient(c *vweb.PluginHTTPClient) error
  • func (T *SitePlugin) ConfigPluginRPCClient(c *vweb.PluginRPCClient) error
• type SitePluginTLS
• type SitePlugins
  • func (T *SitePlugins) ConfigSitePluginHTTP(origin *SitePlugin, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *SitePlugins) ConfigSitePluginRPC(origin *SitePlugin, handle func(name string, dsc, src reflect.Value) bool) bool
• type SiteProperty
• type SitePublic
  • func (T *SitePublic) ConfigSiteDynamic(origin *SiteDynamic, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *SitePublic) ConfigSiteForward(origin *SiteForwards, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *SitePublic) ConfigSiteHeader(origin *SiteHeader, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *SitePublic) ConfigSiteProperty(origin *SiteProperty, handle func(name string, dsc, src reflect.Value) bool) bool
  • func (T *SitePublic) ConfigSiteSession(origin *SiteSession, handle func(name string, dsc, src reflect.Value) bool) bool
• type SiteSession
• type Sites

Types

type Config

type Config struct {
	Servers Servers // 服务器集
	Sites   Sites   // 站点集
}

Config 配置

func (*Config) ParseFile

func (T *Config) ParseFile(file string) error

ParseFile 解析服务器配置文件，一个JSON格式的文件。

参：
  file string     文件
返：
  error           错误，如果文件无法打开，或无法解析的情况

func (*Config) ParseReader

func (T *Config) ParseReader(r io.Reader) error

ParseReader 解析服务器配置数据，一个JSON格式的数据。

参：
  r   io.Reader       读接口
返：
  error               错误，如果无法解析的情况

type Conn

type Conn struct {
	// 引用公共配置后，该以结构中的CC和CS如果也有设置，将会使用优先使用。
	PublicName      string // 引用公共配置的名字
	Deadline        int64  // 设置读写超时(毫秒单位)
	WriteDeadline   int64  // 设置写入超时(毫秒单位)
	ReadDeadline    int64  // 设置读取超时(毫秒单位)
	KeepAlive       bool   // 即使没有任何通信，一个客户端可能希望保持连接到服务器的状态。
	KeepAlivePeriod int64  // 保持连接超时(毫秒单位)
	Linger          int    // 连接关闭后，等待发送或待确认的数据（秒单位)。如果 sec > 0，经过sec秒后，所有剩余的未发送数据都可能会被丢弃。则与sec < 0 一样在后台发送数据。
	NoDelay         bool   // 设置操作系统是否延迟发送数据包,建议设置为true(无延迟)
	ReadBuffer      int    // 在缓冲区读取数据大小
	WriteBuffer     int    // 写入数据到缓冲区大小
}

type Listen

type Listen struct {
	Status bool   // 状态，是否启动此服务器
	CC     Conn   // 连接设置
	CS     Server // 服务器设置
}

type Server

type Server struct {
	// 引用公共配置后，该以结构中的CC和CS如果也有设置，将会使用优先使用。
	PublicName                   string     // 引用公共配置的名字
	ReadTimeout                  int64      // 设置读取超时(毫秒单位)
	WriteTimeout                 int64      // 设置写入超时(毫秒单位)
	ReadHeaderTimeout            int64      // 读取标头超时(毫秒单位）
	IdleTimeout                  int64      // 保持连接空闲超时，如果为0，使用 ReadTimeout,(毫秒单位）
	MaxHeaderBytes               int        // 如果0，最大请求头的大小，http.DefaultMaxHeaderBytes
	KeepAlivesEnabled            bool       // 支持客户端Keep-Alive
	ShutdownConn                 bool       // 服务器关闭监听，不会即时关闭正在下载的连接。空闲后再关闭。(默认即时关闭)
	DisableGeneralOptionsHandler bool       // 如果为真，将“OPTIONS *”请求传递给处理程序，否则响应 200 OK 和 Content-Length: 0。
	TLS                          *ServerTLS // TLS
}

type ServerPublic

type ServerPublic struct {
	CC map[string]Conn   // 连接设置
	CS map[string]Server // 服务器设置
}

func (*ServerPublic) ConfigConn

func (T *ServerPublic) ConfigConn(origin *Conn, handle func(name string, dsc, src reflect.Value) bool) bool

func (*ServerPublic) ConfigServer

func (T *ServerPublic) ConfigServer(origin *Server, handle func(name string, dsc, src reflect.Value) bool) bool

type ServerTLS

type ServerTLS struct {
	RootCAs                     []ServerTLSFile // 服务端证书文件
	NextProtos                  []string        // http版本
	CipherSuites                []uint16        // 密码套件
	SessionTicketsDisabled      bool            // 设置为 true 可禁用会话票证 (恢复) 支持。
	SetSessionTicketKeys        [][32]byte      // 会话恢复票证
	DynamicRecordSizingDisabled bool            // 禁用TLS动态记录自适应大小
	MinVersion                  uint16          // 最小SSL/TLS版本。如果为零，则SSLv3的被取为最小。
	MaxVersion                  uint16          // 最大SSL/TLS版本。如果为零，则该包所支持的最高版本被使用。
	ClientCAs                   []string        // 客户端拥有的“权威组织”证书的列表。(Server/Client端使用)
}

func (*ServerTLS) CipherSuitesAuto

func (T *ServerTLS) CipherSuitesAuto()

type ServerTLSFile

type ServerTLSFile struct {
	CertFile, KeyFile string // 证书，key 文件地址
}

type Servers

type Servers struct {
	Public ServerPublic
	Listen map[string]Listen
}

type Site

type Site struct {
	Status   bool   // 状态，是否启动此站点
	Name     string // 站点别名
	Identity string // 站点维一码，可以说是池名

	Host      []string                // 域名绑定
	Forward   map[string]SiteForwards // 转发
	Plugin    SitePlugins             // 插件
	Directory SiteDirectory           // 目录

	IndexFile []string // 默认页
	Dynamic   SiteDynamic

	Header    SiteHeader        // HTTP头
	Log       SiteLog           // 日志
	ErrorPage map[string]string // 错误页

	Session  SiteSession  // 会话
	Property SiteProperty // 性能
}

配置-站点

type SiteDirectory

type SiteDirectory struct {
	Root    string   // 主目录
	Virtual []string // 虚目录
}

配置-目录

func (*SiteDirectory) RootDir

func (T *SiteDirectory) RootDir(upath string) string

根目录

r *http.Request	    		请求
string			    		根目录路径

type SiteDynamic

type SiteDynamic struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName string // 引用公共配置的名字

	Ext                []string // 动态文件后缀
	Cache              bool     // 动态文件缓存解析，非缓存执行
	CacheParseTimeout  int64    // 动态文件缓存解析超时，（秒为单位）
	CacheStaticFileDir string   // 缓存静态文件目录，仅适于markdown转HTML
	CacheStaticTimeout int64    // 缓存静态超时，（秒为单位）
}

type SiteForward

type SiteForward struct {
	Status       bool     // 启用或禁止
	Path         []string // 多种路径匹配
	ExcludePath  []string // 排除多种路径匹配
	RePath       string   // 重写路径
	RedirectCode int      // 重定向状态码，默认不转向
	End          bool     // 不进行二次
}

配置-转发-配置

func (*SiteForward) Rewrite

func (T *SiteForward) Rewrite(upath string) (rpath string, rewrited bool, err error)

type SiteForwards

type SiteForwards struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName string // 引用公共配置的名字

	List []SiteForward
}

type SiteHeader

type SiteHeader struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName      string                    // 引用公共配置的名字
	Static, Dynamic map[string]SiteHeaderType // 静态，动态Header，map[".html"]ConfigSiteHeaderType
	MIME            map[string]string         // MIME类型
}

配置-标头

type SiteHeaderType

type SiteHeaderType struct {
	Header      map[string][]string // Header
	PageExpired int64               // 页面过期(秒单位)
}

配置-标头-类型

type SiteLog

type SiteLog struct {
	Level     SiteLogLevel // 级别
	Directory string       // 目录
}

配置-日志，这个功能后面待加。

type SiteLogLevel

type SiteLogLevel int

配置-日志-级别

const (
	SiteLogLevelDisable SiteLogLevel = iota // 禁用日志记录，默认不开启
)

type SitePlugin

type SitePlugin struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName string // 引用公共配置的名字
	Status     bool   // 状态，是否启用

	// 公共
	Addr          string // 地址
	LocalAddr     string // 本地拨号IP
	Timeout       int64  // 拨号超时（毫秒单位）
	KeepAlive     int64  // 保持连接超时（毫秒单位）
	FallbackDelay int64  // 后退延时，等待双协议栈延时，（毫秒单位，默认300ms）。
	IdeConn       int    // 空闲连接数

	// RPC
	Path    string // 路径
	MaxConn int    // 最大连接数

	// HTTP
	ProxyURL               string         // 验证用户密码或是否使用socks5
	Host                   string         // Host
	Scheme                 string         // 协议
	TLS                    *SitePluginTLS // TLS
	TLSHandshakeTimeout    int64          // 握手超时（毫秒单位）
	DisableKeepAlives      bool           // 禁止长连接
	DisableCompression     bool           // 禁止压缩
	MaxIdleConnsPerHost    int            // 最大空闲连接每个主机
	MaxConnsPerHost        int            // 最大连接的每个主机
	IdleConnTimeout        int64          // 设置空闲连接超时（毫秒单位）
	ResponseHeaderTimeout  int64          // 请求Header超时（毫秒单位）
	ExpectContinueTimeout  int64          // 发送Expect: 100-continue标头的PUT请求超时
	ProxyConnectHeader     http.Header    // CONNECT代理请求中 增加标头 map[string][]string
	MaxResponseHeaderBytes int64          // 最大的响应标头限制（字节）
	ReadBufferSize         int            // 读取缓冲大小
	WriteBufferSize        int            // 写入缓冲大小
	ForceAttemptHTTP2      bool           // 支持HTTP2
}

配置-插件

func (*SitePlugin) ConfigPluginHTTPClient

func (T *SitePlugin) ConfigPluginHTTPClient(c *vweb.PluginHTTPClient) error

func (*SitePlugin) ConfigPluginRPCClient

func (T *SitePlugin) ConfigPluginRPCClient(c *vweb.PluginRPCClient) error

type SitePluginTLS

type SitePluginTLS struct {
	ServerName         string        // 服务器名称
	InsecureSkipVerify bool          // 跳过证书验证
	NextProtos         []string      // TCP 协议，如：http/1.1
	CipherSuites       []uint16      // 密码套件的列表。
	ClientSessionCache int           // 是TLS会话恢复 ClientSessionState 条目的缓存。(Client端使用)
	CurvePreferences   []tls.CurveID // 在ECDHE握手中使用(Client端使用)
	RootCAs            []string      // 根证书文件
}

配置-插件-配置-TLS

type SitePlugins

type SitePlugins struct {
	RPC  map[string]SitePlugin
	HTTP map[string]SitePlugin
}

配置-插件

func (*SitePlugins) ConfigSitePluginHTTP

func (T *SitePlugins) ConfigSitePluginHTTP(origin *SitePlugin, handle func(name string, dsc, src reflect.Value) bool) bool

func (*SitePlugins) ConfigSitePluginRPC

func (T *SitePlugins) ConfigSitePluginRPC(origin *SitePlugin, handle func(name string, dsc, src reflect.Value) bool) bool

type SiteProperty

type SiteProperty struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName string // 引用公共配置的名字

	ConnMaxNumber int64 // 连接最大数量
	ConnSpeed     int64 // 连接宽带速度
	BuffSize      int   // 缓冲区大小
}

配置-性能

type SitePublic

type SitePublic struct {
	Header   map[string]SiteHeader
	Session  map[string]SiteSession
	Plugin   SitePlugins
	Forward  map[string]SiteForwards
	Property map[string]SiteProperty
	Dynamic  map[string]SiteDynamic
}

func (*SitePublic) ConfigSiteDynamic

func (T *SitePublic) ConfigSiteDynamic(origin *SiteDynamic, handle func(name string, dsc, src reflect.Value) bool) bool

func (*SitePublic) ConfigSiteForward

func (T *SitePublic) ConfigSiteForward(origin *SiteForwards, handle func(name string, dsc, src reflect.Value) bool) bool

func (*SitePublic) ConfigSiteHeader

func (T *SitePublic) ConfigSiteHeader(origin *SiteHeader, handle func(name string, dsc, src reflect.Value) bool) bool

func (*SitePublic) ConfigSiteProperty

func (T *SitePublic) ConfigSiteProperty(origin *SiteProperty, handle func(name string, dsc, src reflect.Value) bool) bool

func (*SitePublic) ConfigSiteSession

func (T *SitePublic) ConfigSiteSession(origin *SiteSession, handle func(name string, dsc, src reflect.Value) bool) bool

type SiteSession

type SiteSession struct {
	// 引用公共配置后，该以结构中的Header如果也有设置，将会使用优先使用。
	PublicName string // 引用公共配置的名字
	Name       string // 会话名称
	Expired    int64  // 过期时间(秒单位，默认20分钟)
	Size       int    // 会话ID长度(默认长度40位)
	Salt       string // 加盐，由于计算机随机数是伪随机数。（可默认为空）
}

配置-性能-会话

type Sites

type Sites struct {
	Public SitePublic
	Site   []Site // 站点
}