control

package

v0.1.0 Latest Latest Go to latest Published: Apr 19, 2026 License: GPL-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/sagernet/sing-cloudflared

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func BuildConnectionOptions(connectorID uuid.UUID, features []string, numPreviousAttempts uint8, ...) *protocol.RegistrationConnectionOptions
func DefaultFeatures(datagramVersion string) []string
func HandleUpdateConfiguration(applyConfig ConfigApplier, ...) error
func IsPermanentRegistrationError(err error) bool
func NewRPCClientConn(transport rpc.Transport) *rpc.Conn
func NewRPCServerConn(transport rpc.Transport, client capnp.Client) *rpc.Conn
func SafeTransport(stream io.ReadWriteCloser) rpc.Transport
func ServeRPCConn(ctx context.Context, stream io.ReadWriteCloser, client capnp.Client)
func ValidateRegistrationResult(result *protocol.RegistrationResult) error
type ConfigApplier
type PermanentRegistrationError
- func (e *PermanentRegistrationError) Error() string
- func (e *PermanentRegistrationError) Unwrap() error
type RegistrationClient
- func CreateRegistrationClient(ctx context.Context, stream io.ReadWriteCloser) *RegistrationClient
type RegistrationRPCClient

Constants ¶

View Source

const (
	RPCTimeout = 5 * time.Second
)

Variables ¶

View Source

var ClientVersion = "sing-cloudflared"

View Source

var ErrNonRemoteManagedTunnelUnsupported = E.New("cloudflared only supports remote-managed tunnels")

View Source

var NewRegistrationClient = func(ctx context.Context, stream io.ReadWriteCloser) RegistrationRPCClient {
	return CreateRegistrationClient(ctx, stream)
}

Functions ¶

func BuildConnectionOptions ¶

func BuildConnectionOptions(connectorID uuid.UUID, features []string, numPreviousAttempts uint8, originLocalIP net.IP) *protocol.RegistrationConnectionOptions

func DefaultFeatures ¶

func DefaultFeatures(datagramVersion string) []string

func HandleUpdateConfiguration ¶

func HandleUpdateConfiguration(applyConfig ConfigApplier, call tunnelrpc.ConfigurationManager_updateConfiguration) error

func IsPermanentRegistrationError ¶

func IsPermanentRegistrationError(err error) bool

func NewRPCClientConn ¶

func NewRPCClientConn(transport rpc.Transport) *rpc.Conn

func NewRPCServerConn ¶

func NewRPCServerConn(transport rpc.Transport, client capnp.Client) *rpc.Conn

func SafeTransport ¶

func SafeTransport(stream io.ReadWriteCloser) rpc.Transport

func ServeRPCConn ¶

func ServeRPCConn(ctx context.Context, stream io.ReadWriteCloser, client capnp.Client)

func ValidateRegistrationResult ¶

func ValidateRegistrationResult(result *protocol.RegistrationResult) error

Types ¶

type ConfigApplier ¶

type ConfigApplier func(version int32, config []byte) config.UpdateResult

type PermanentRegistrationError ¶

type PermanentRegistrationError struct {
	Err error
}

func (*PermanentRegistrationError) Error ¶

func (e *PermanentRegistrationError) Error() string

func (*PermanentRegistrationError) Unwrap ¶

func (e *PermanentRegistrationError) Unwrap() error

type RegistrationClient ¶

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

func CreateRegistrationClient ¶

func CreateRegistrationClient(ctx context.Context, stream io.ReadWriteCloser) *RegistrationClient

func (*RegistrationClient) Close ¶

func (c *RegistrationClient) Close() error

func (*RegistrationClient) RegisterConnection ¶

func (c *RegistrationClient) RegisterConnection(
	ctx context.Context,
	auth protocol.TunnelAuth,
	tunnelID uuid.UUID,
	connIndex uint8,
	options *protocol.RegistrationConnectionOptions,
) (*protocol.RegistrationResult, error)

func (*RegistrationClient) Unregister ¶

func (c *RegistrationClient) Unregister(ctx context.Context) error

type RegistrationRPCClient ¶

type RegistrationRPCClient interface {
	RegisterConnection(
		ctx context.Context,
		auth protocol.TunnelAuth,
		tunnelID uuid.UUID,
		connIndex uint8,
		options *protocol.RegistrationConnectionOptions,
	) (*protocol.RegistrationResult, error)
	Unregister(ctx context.Context) error
	Close() error
}

Source Files ¶

View all Source files

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