connect

README

Minekube Connect

Connect allows you to connect any Minecraft server, whether it's in online mode, public, behind your protected home network or anywhere else in the world, with our highly available, performant and low latency edge proxies network nearest to you.

Browse active servers now! Join minekube.net with your Minecraft client!

Note that the client is open source, but not the server side production service.

Features

• ProtoBuf typed
• Streaming transport protocols
  • WebSocket support
    • equally or more efficient than gRPC
    • better web proxy support: cloudflared, nginx, ...
  • gRPC support (improved developer experience)
    • No immediate support planned, see
• Minekube Connect plugin support for:
  • Gate
  • Spigot/PaperMC
  • Velocity
  • BungeeCord
  • Sponge
  • Minestom
• Client side service tooling in Go
• Server side service tooling in Go
• Client- & service-side tests implementation in Go
• Awesome documentation website

Documentation

Index

• Constants
• func WithTunnelOptions(ctx context.Context, opts TunnelOptions) context.Context
• type Addr
  • func (a Addr) Network() string
  • func (a Addr) String() string
• type Authentication
• type Endpoint
• type EndpointListener
• type EndpointWatch
• type GameProfile
• type GameProfileProperty
• type Listener
• type Player
• type ReceiveProposal
• type RejectionReason
• type Session
• type SessionProposal
• type SessionRejection
• type Tunnel
• type TunnelListener
• type TunnelOptions
• type Tunneler
• type WatchRequest
• type WatchResponse
• type Watcher

Constants

const (
	MDPrefix   = "connect-"            // The prefix of Connect metadata keys.
	MDSession  = MDPrefix + "session"  // Metadata key specifying the session id for a Tunnel.
	MDEndpoint = MDPrefix + "endpoint" // Metadata key specifying the watching Endpoint.
)

Well-known headers / metadata keys

Functions

func WithTunnelOptions

func WithTunnelOptions(ctx context.Context, opts TunnelOptions) context.Context

WithTunnelOptions stores TunnelOptions in a context.

Types

type Addr

type Addr string

Addr is an address in the "connect" network.

func (Addr) Network

func (a Addr) Network() string

func (Addr) String

func (a Addr) String() string

type Authentication

type Authentication = pb.Authentication

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type Endpoint

type Endpoint interface {
	Watcher
	Tunneler
}

Endpoint is an endpoint that listens for sessions to either reject them or establish a tunnel for receiving the connection.

type EndpointListener

type EndpointListener interface {
	AcceptEndpoint(context.Context, EndpointWatch) error
}

EndpointListener is a network listener for endpoint watches.

type EndpointWatch

type EndpointWatch interface {
	// Propose proposes a session to the Endpoint.
	// The Endpoint either rejects the proposal or initiates
	// a Tunnel to receive the session connection.
	Propose(context.Context, *Session) error
	Rejections() <-chan *SessionRejection // Rejections receives rejected session proposals from the Endpoint.
}

EndpointWatch is a watching Endpoint.

type GameProfile

type GameProfile = pb.GameProfile

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type GameProfileProperty

type GameProfileProperty = pb.GameProfileProperty

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type Listener

type Listener interface {
	EndpointListener
	TunnelListener
}

Listener listens for watching endpoints and tunnel connections from endpoints.

type Player

type Player = pb.Player

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type ReceiveProposal

type ReceiveProposal func(proposal SessionProposal) error

ReceiveProposal is called when Watcher receives a SessionProposal.

type RejectionReason

type RejectionReason = status.Status // The reason why a session proposal is rejected.

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type Session

type Session = pb.Session

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type SessionProposal

type SessionProposal interface {
	Session() *Session                              // The session proposed to connect to the Endpoint.
	Reject(context.Context, *RejectionReason) error // Rejects the session proposal with an optional reason.
}

SessionProposal specifies an incoming session proposal. Use the Session to create the connection tunnel or reject the session with an optional reason.

type SessionRejection

type SessionRejection = pb.SessionRejection

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type Tunnel

type Tunnel net.Conn

Tunnel represents an outbound only tunnel initiated by an Endpoint for a specific SessionProposal.

type TunnelListener

type TunnelListener interface {
	AcceptTunnel(context.Context, Tunnel) error
}

TunnelListener is a network listener for tunnel connections.

type TunnelOptions

type TunnelOptions struct {
	// LocalAddr fakes the local address of the Tunnel when specified.
	//
	// If this TunnelOptions destine to Tunneler
	// it is recommended to use the Endpoint address/name.
	//
	// If this TunnelOptions destine to TunnelListener
	// it is recommended to use the underlying network listener address.
	LocalAddr net.Addr
	// RemoteAddr fakes the remote address of the Tunnel when specified.
	//
	// If this TunnelOptions destine to Tunneler
	// it is recommended to use the underlying connection remote address.
	//
	// If this TunnelOptions destine to TunnelListener
	// it is recommended to use the Endpoint address/name.
	RemoteAddr net.Addr // It is recommended to use the player address.
}

TunnelOptions are options for Tunneler and TunnelListener. Use WithTunnelOptions to propagate TunnelOptions in context.

type Tunneler

type Tunneler interface {
	Tunnel(context.Context) (Tunnel, error)
}

Tunneler creates a Tunnel.

type WatchRequest

type WatchRequest = pb.WatchRequest

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type WatchResponse

type WatchResponse = pb.WatchResponse

Type alias to better support updating versions. See the referenced type for documentation.

Other go files should only ever use the provided alias type and never import a specific proto version.

type Watcher

type Watcher interface {
	Watch(context.Context, ReceiveProposal) error
}

Watcher registers the calling endpoint and watches for sessions proposed by the WatchService. To stop watching cancel the context. If ReceiveProposal returns a non-nil non-EOF error Watch returns it.