1
0
mirror of https://github.com/v2fly/v2ray-core.git synced 2024-10-14 06:53:39 -04:00
v2fly/proxy/proxy.go

49 lines
1.6 KiB
Go
Raw Normal View History

// Package proxy contains all proxies used by V2Ray.
2017-02-13 16:11:36 -05:00
//
// To implement an inbound or outbound proxy, one needs to do the following:
// 1. Implement the interface(s) below.
// 2. Register a config creator through common.RegisterConfig.
2016-08-19 11:05:15 -04:00
package proxy
import (
2017-01-14 18:17:06 -05:00
"context"
"github.com/v2fly/v2ray-core/v5/common/net"
"github.com/v2fly/v2ray-core/v5/common/protocol"
"github.com/v2fly/v2ray-core/v5/features/routing"
"github.com/v2fly/v2ray-core/v5/transport"
"github.com/v2fly/v2ray-core/v5/transport/internet"
)
2017-01-26 14:57:18 -05:00
// An Inbound processes inbound connections.
type Inbound interface {
2018-11-20 10:58:26 -05:00
// Network returns a list of networks that this inbound supports. Connections with not-supported networks will not be passed into Process().
Network() []net.Network
2017-02-13 07:13:21 -05:00
// Process processes a connection of given network. If necessary, the Inbound can dispatch the connection to an Outbound.
Process(context.Context, net.Network, internet.Connection, routing.Dispatcher) error
}
2017-01-26 14:57:18 -05:00
// An Outbound process outbound connections.
type Outbound interface {
2017-02-13 07:13:21 -05:00
// Process processes the given connection. The given dialer may be used to dial a system outbound connection.
2018-11-03 07:36:29 -04:00
Process(context.Context, *transport.Link, internet.Dialer) error
2017-01-14 18:17:06 -05:00
}
2018-02-05 17:38:24 -05:00
// UserManager is the interface for Inbounds and Outbounds that can manage their users.
type UserManager interface {
// AddUser adds a new user.
2018-08-26 18:11:32 -04:00
AddUser(context.Context, *protocol.MemoryUser) error
2018-02-05 17:38:24 -05:00
// RemoveUser removes a user by email.
2018-02-05 17:38:24 -05:00
RemoveUser(context.Context, string) error
}
type GetInbound interface {
GetInbound() Inbound
}
type GetOutbound interface {
GetOutbound() Outbound
2018-02-05 17:39:04 -05:00
}