box

README

sing-box

The universal proxy platform.

Documentation

https://sing-box.sagernet.org

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

Index

• func Context(ctx context.Context, inboundRegistry adapter.InboundRegistry, ...) context.Context
• type Box
  • func New(options Options) (*Box, error)
  • func (s *Box) Close() error
  • func (s *Box) Inbound() adapter.InboundManager
  • func (s *Box) Network() adapter.NetworkManager
  • func (s *Box) Outbound() adapter.OutboundManager
  • func (s *Box) PreStart() error
  • func (s *Box) Router() adapter.Router
  • func (s *Box) Start() error
• type Options

Functions

func Context

func Context(
	ctx context.Context,
	inboundRegistry adapter.InboundRegistry,
	outboundRegistry adapter.OutboundRegistry,
	endpointRegistry adapter.EndpointRegistry,
) context.Context

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) Inbound

func (s *Box) Inbound() adapter.InboundManager

func (*Box) Network

func (s *Box) Network() adapter.NetworkManager

func (*Box) Outbound

func (s *Box) Outbound() adapter.OutboundManager

func (*Box) PreStart

func (s *Box) PreStart() error

func (*Box) Router

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

func (*Box) Start

func (s *Box) Start() error

type Options

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