mirror of
https://github.com/XTLS/Xray-core.git
synced 2024-12-23 14:09:49 +00:00
496b2c02c5
* Fix Dial function crash instance when there is no instance context in the ctx * check ctx to fix. (#841) * Feat: core.ToContext(ctx, v) for ctx initialization (#852) * remove exported API: toContext * Remove unnecessary API * rework document for API * fix: make sure the ctx is propagated to connections by detached connection Co-authored-by: Shelikhoo <xiaokangwang@outlook.com> Co-authored-by: rurirei <72071920+rurirei@users.noreply.github.com>
84 lines
2.7 KiB
Go
84 lines
2.7 KiB
Go
package core
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
|
|
"github.com/xtls/xray-core/common"
|
|
"github.com/xtls/xray-core/common/net"
|
|
"github.com/xtls/xray-core/common/net/cnc"
|
|
"github.com/xtls/xray-core/features/routing"
|
|
"github.com/xtls/xray-core/transport/internet/udp"
|
|
)
|
|
|
|
// 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 = toContext(v.ctx, 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))
|
|
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) {
|
|
ctx = toContext(ctx, v)
|
|
|
|
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
|
|
if dest.Network == net.Network_TCP {
|
|
readerOpt = cnc.ConnectionOutputMulti(r.Reader)
|
|
} else {
|
|
readerOpt = cnc.ConnectionOutputMultiUDP(r.Reader)
|
|
}
|
|
return cnc.NewConnection(cnc.ConnectionInputMulti(r.Writer), readerOpt), nil
|
|
}
|
|
|
|
// 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) {
|
|
ctx = toContext(ctx, v)
|
|
|
|
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))
|
|
}
|