Xray-core/core/functions.go

79 lines
2.7 KiB
Go
Raw Normal View History

2020-11-25 11:01:53 +00:00
package core
import (
"bytes"
"context"
2020-12-04 01:36:16 +00:00
"github.com/xtls/xray-core/common"
"github.com/xtls/xray-core/common/net"
"github.com/xtls/xray-core/common/net/cnc"
2020-12-04 01:36:16 +00:00
"github.com/xtls/xray-core/features/routing"
"github.com/xtls/xray-core/transport/internet/udp"
2020-11-25 11:01:53 +00:00
)
// CreateObject creates a new object based on the given Xray instance and config. The Xray instance may be nil.
func CreateObject(v *Instance, config interface{}) (interface{}, error) {
ctx := v.ctx
if v != nil {
ctx = context.WithValue(ctx, xrayKey, v)
}
return common.CreateObject(ctx, config)
}
// StartInstance starts a new Xray instance with given serialized config.
// By default Xray only support config in protobuf format, i.e., configFormat = "protobuf". Caller need to load other packages to add JSON support.
//
// xray:api:stable
func StartInstance(configFormat string, configBytes []byte) (*Instance, error) {
config, err := LoadConfig(configFormat, bytes.NewReader(configBytes))
2020-11-25 11:01:53 +00:00
if err != nil {
return nil, err
}
instance, err := New(config)
if err != nil {
return nil, err
}
if err := instance.Start(); err != nil {
return nil, err
}
return instance, nil
}
// Dial provides an easy way for upstream caller to create net.Conn through Xray.
// It dispatches the request to the given destination by the given Xray instance.
// Since it is under a proxy context, the LocalAddr() and RemoteAddr() in returned net.Conn
// will not show real addresses being used for communication.
//
// xray:api:stable
func Dial(ctx context.Context, v *Instance, dest net.Destination) (net.Conn, error) {
dispatcher := v.GetFeature(routing.DispatcherType())
if dispatcher == nil {
return nil, newError("routing.Dispatcher is not registered in Xray core")
}
r, err := dispatcher.(routing.Dispatcher).Dispatch(ctx, dest)
if err != nil {
return nil, err
}
var readerOpt cnc.ConnectionOption
2020-11-25 11:01:53 +00:00
if dest.Network == net.Network_TCP {
readerOpt = cnc.ConnectionOutputMulti(r.Reader)
2020-11-25 11:01:53 +00:00
} else {
readerOpt = cnc.ConnectionOutputMultiUDP(r.Reader)
2020-11-25 11:01:53 +00:00
}
return cnc.NewConnection(cnc.ConnectionInputMulti(r.Writer), readerOpt), nil
2020-11-25 11:01:53 +00:00
}
// DialUDP provides a way to exchange UDP packets through Xray instance to remote servers.
// Since it is under a proxy context, the LocalAddr() in returned PacketConn will not show the real address.
//
// TODO: SetDeadline() / SetReadDeadline() / SetWriteDeadline() are not implemented.
//
// xray:api:beta
func DialUDP(ctx context.Context, v *Instance) (net.PacketConn, error) {
dispatcher := v.GetFeature(routing.DispatcherType())
if dispatcher == nil {
return nil, newError("routing.Dispatcher is not registered in Xray core")
}
return udp.DialDispatcher(ctx, dispatcher.(routing.Dispatcher))
}