box

package module

v1.8.13 Latest Latest Go to latest Published: May 3, 2024 License: GPL-2.0 Imports: 32 Imported by: 15

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sagernet/sing-box

README ¶

sing-box

The universal proxy platform.

Documentation

https://sing-box.sagernet.org

Support

https://community.sagernet.org/c/sing-box/

License

Copyright (C) 2022 by nekohasekai <contact-sagernet@sekai.icu>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

In addition, no derivative work may use the name or imply association
with this application without prior consent.

Documentation ¶

Rendered for

Index ¶

type Box
- func New(options Options) (*Box, error)
type Options

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Box ¶

type Box struct {
	// contains filtered or unexported fields
}

func New ¶

func New(options Options) (*Box, error)

func (*Box) Close ¶

func (s *Box) Close() error

func (*Box) PreStart ¶ added in v1.2.0

func (s *Box) PreStart() error

func (*Box) Router ¶ added in v1.1.0

func (s *Box) Router() adapter.Router

func (*Box) Start ¶

func (s *Box) Start() error

type Options ¶ added in v1.2.3

type Options struct {
	option.Options
	Context           context.Context
	PlatformInterface platform.Interface
	PlatformLogWriter log.PlatformWriter
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
adapter
cmd
internal/build
internal/build_libbox
internal/build_shared
internal/protogen
internal/read_tag
internal/update_android_version
internal/update_apple_version
sing-box
common
badtls
badversion
conntrack
dialer
geoip
geosite
humanize
interrupt
mux
pipelistener
process
redir
settings
sniff
sniff/internal/qtls
srs
taskmonitor
tls
uot
urltest
constant
goos package goos contains GOOS-specific constants.	package goos contains GOOS-specific constants.
experimental
cachefile
clashapi
clashapi/compatible
clashapi/trafficontrol
libbox
libbox/internal/procfs
libbox/platform
v2rayapi
inbound
include
log
ntp
option
outbound
route
transport
dhcp
fakeip
simple-obfs
sip003
trojan
v2ray
v2raygrpc
v2raygrpc/credentials Package credentials defines APIs for parsing SPIFFE ID.	Package credentials defines APIs for parsing SPIFFE ID.
v2raygrpclite
v2rayhttp
v2rayhttpupgrade
v2rayquic
v2raywebsocket
vless
wireguard

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL